Bamboo Auctions API

Token ¶

In order to make authorized calls to Bamboo’s APIs, your application must first obtain an OAuth access token on behalf of a Bamboo Auctions user.

Bamboo’s implementation is based on the Client Credentials Grant flow of the OAuth 2 specification.

Once a token has been granted, it is used to make subsequent requests to the API

Server ¶

Property ¶

Resources related to properties in the API. A property is any auction lot.

Note that Bamboo Auctions supports API versioning, which is specified in headers. It is optional, however, it is recommended to request a specific version otherwise the latest will be used, which could otherwise introduce breaking features in the future. Bamboo Auctions supports semver style versioning, that is, only major version increases will introduce breaking changes.

Uploading an auction lot revolves around the property object. This is a list of information related to an auction lot, including details important to running an auctions, specifically a reserve, guide price and an auction end date and time.

Not all object properties are required, and some are read-only, when retrieved, created by the API and the auction process itself.

{
  title: String, // This is the title of the auction listing
  handle: String, // This is the generated url string
  description: String, // A longer description, expected to be several paragraphs in length
  type: String, // One of ['Residential', 'Commercial', 'Land', 'Other']
  auctionType: String, // One of ['traditional', 'conditional']
  holdingDeposit: Number,
  numberOfBedrooms: Number,  //optional
  numberOfReceptions: Number, // optional
  numberOfBathrooms: Number, // optional
  otherNotes: String, // optional
  startPrice: Number, // Starting price of the auction
  guidePrice: Number, // Must be within 10% of reserve value when specified (ASA rules)
  soldPrice: Number,
  useDefaultIncrement: Boolen,
  baseIncrement: Boolen,
  afterReserveIncrement: Boolen,
  reserve: Number, // optional
  addressLineOne: String, // Address of the property
  addressLineTwo: String, // Address of the property
  city: String, // Address of the property
  postcode: String, // Address of the property
  uprn: String,
  thumbnailImage: String,
  solicitorName: String, // Seller's solicitor: Memorandum of Sale generation and emailing
  solicitorEmail: String, // Seller's solicitor: Memorandum of Sale generation and emailing
  solicitorPhone: String, // Seller's solicitor: Memorandum of Sale generation and emailing
  solicitorAddress: String, // Seller's solicitor: Memorandum of Sale generation and emailing
  solicitorContact: String, // Seller's solicitor: Memorandum of Sale generation and emailing
  agentName: String,
  agentPhone: String,
  agentEmail: String,
  sellerName: String, // Seller's: Memorandum of Sale generation and emailing
  sellerAddress: String, // Seller's: Memorandum of Sale generation and emailing
  preauction: Boolean,
  soldExternally: Boolean,
  isVatApplicable: Boolean, // false under normal conditions
  amenities: [String] // Any list of values related to the property, eg, ["Off-road parking", "Patio"], or [] for none.
}