Bamboo Auctions API

API Endpoint

This documents access to the API for the Bamboo Auctions online auction platform. The Bamboo API provides read/write access to auction lots via a simple REST API, utilising OAuth v2.

If you would like to integrate your platform with Bamboo Auctions please send an email to hello@bambooauctions.com or phone 0330 088 9659.

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

Auth Flow

A Bamboo Auctions seller is given a unique consumer key and secret and is available to them in their Dashboard. This information will need to be stored, in their configuration, of the uploading tool.

  • An application encodes its consumer key and secret into a specially encoded set of credentials.

  • An application makes a request to the POST oauth2 / token endpoint to exchange these credentials for a bearer token.

  • When accessing the REST API, the application uses the bearer token to authenticate.

Encoding the consumer key and secret

  1. URL encode the consumer key and secret values

  2. Concatenate the URL encoded consumer key, a colon “:”, and the secret

  3. Base64 encode the resulting string

POST /token
Requestsexample 1
Headers
Authorization: Basic {key_secret}
Content-Type: application/json
Body
{
  "grant_type": "client_credentials"
}
Responses200
Headers
Content-Type: application/json
Body
{
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2Nlc3NMZXZlbCI6ImJyYW5jaCIsIm9yZ2FuaXNhdGlvbiI6ImJhbWJvbyIsImJyYW5jaCI6ImJhbWJvbyIsImlhdCI6MTQ2MTkyNTIwOSwic3ViIjoiNTZmYmJiMWNiMDY4MTFlMzM1MTNlMWJhIn0.dd3k1PBxvYI8d6DQodxLKIFV-wQiCBD31VzEB4_om0w",
  "token_type": "Bearer"
}

Request a Bearer Token
POST/token

URI Parameters
HideShow
key_secret
string (required) 

Encoded consumer key and secret


Server

Details

This resource provides information about the running API server. This may be useful for determining the latest running version number, to a client.

GET /api/server
Requestsexample 1
Headers
Authorization: Bearer {token}
Content-Type: application/json
Responses200
Headers
Content-Type: application/json
Content-Length: 158
Content-Type: application/json
Body
{
  "name": "BambooAPI",
  "description": "Bamboo Auctions API",
  "currentVersion": "1.0.12",
  "serverTime": "2016-04-29T13:54:38.372Z",
  "uptime": "00:04:03.923000000000002"
}

Obtain Server Information
GET/api/server

URI Parameters
HideShow
token
string (required) 

bearer token retrieved from /token request.


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.
}

Property Collection

POST /api/property
Requestsexample 1
Headers
Authorization: Bearer {token}
Content-Type: application/json
Accept-Version: 1.0.0
Body
{
  "title": "2 Bed Flat",
  "description": "It's got 2 bedrooms",
  "type": "Residential",
  "numberOfBedrooms": 2,
  "numberOfReceptions": 1,
  "numberOfBathrooms": 1,
  "otherNotes": "It's in a nice area.",
  "guidePrice": 100000,
  "reserve": 110000,
  "addressLineOne": "123 Fake Street",
  "addressLineTwo": "Estate",
  "city": "London",
  "postcode": "AA1 1AA",
  "solicitorName": "Chris Solicitor",
  "solicitorEmail": "chris@solicitor.com",
  "solicitorPhone": "01234 567890",
  "solicitorAddress": "123 Fake Street",
  "solicitorContact": "Chris Smith",
  "sellerName": "John Seller",
  "sellerAddress": "10 High Street",
  "isVatApplicable": false,
  "amenities": [
    "Garage",
    "Garden"
  ]
}
Responses201
Headers
Content-Type: application/json
Body
{
  "location": {
    "type": "Point",
    "coordinates": [
      -0.1S509
    ]
  },
  "finaliseState": {
    "notifiedBiddersUnsold": false,
    "notifiedAuctioneer": false,
    "notifiedAuctioneerUnsold": false,
    "notifiedBuyersSolicitorSold": false,
    "notifiedSellersSolicitorSold": false,
    "notifiedUnsuccessfulBidders": false,
    "notifiedWinner": false,
    "paymentProcessed": false
  },
  "type": "Residential",
  "auctionType": "traditional",
  "startPrice": 0,
  "useDefaultIncrement": true,
  "thumbnailImage": "/img/440x330.jpg",
  "preauction": false,
  "soldExternally": false,
  "amenities": [
    "Garage",
    "Garden"
  ],
  "status": "draft",
  "finalized": false,
  "pageviewCount": 0,
  "watchListCount": 0,
  "branch": "bamboo",
  "organisation": "bamboo",
  "isVatApplicable": false,
  "statusRank": 2,
  "_id": "60a21dcadd55d91c6719f4fa",
  "title": "2 Bed Flat",
  "description": "It's got 2 bedrooms",
  "numberOfBedrooms": "2",
  "numberOfReceptions": "1",
  "numberOfBathrooms": "1",
  "otherNotes": "It's in a nice area.",
  "guidePrice": 100000,
  "reserve": 110000,
  "addressLineOne": "123 Fake Street",
  "addressLineTwo": "Estate",
  "city": "London",
  "postcode": "AA1 1AA",
  "solicitorName": "Chris Solicitor",
  "solicitorPhone": "01234 567890",
  "solicitorEmail": "chris@solicitor.com",
  "solicitorContact": "Chris Smith",
  "solicitorAddress": "123 Fake Street",
  "sellerName": "John Seller",
  "sellerAddress": "10 High Street",
  "handle": "2-bed-flat-3035546",
  "user": "5bdad000ae601b00047304dc",
  "galleryImages": [],
  "floorplanImages": [],
  "documents": [],
  "viewingDates": [],
  "bookedViewings": [],
  "bids": [],
  "createdAt": "2021-05-17T07:39:54.638Z",
  "updatedAt": "2021-05-17T07:39:54.638Z",
  "__v": 0,
  "previewURL": "http://develop.127.0.0.1:undefined/property/2-bed-flat-3035546",
  "isReserveMet": false,
  "highestBid": 0,
  "numberOfBids": 0,
  "activeBids": [],
  "fullAddress": "123 Fake Street, Estate, London, AA1 1AA",
  "id": "60a21dcadd55d91c6719f4fa"
}

Create a New Property
POST/api/property

URI Parameters
HideShow
token
string (required) 

bearer token retrieved from /token request.


GET /api/property
Requestsexample 1
Headers
Authorization: Bearer {token}
Content-Type: application/json
Accept-Version: 1.0.0
Responses200
Headers
Content-Type: application/json
Content-Length: 7790
Content-Type: application/json
X-Total-Count: 2
link: <api.bambooauctions.com/api/property?page=0>; rel="first",<api.bambooauctions.com/api/property?page=0>; rel="last"
Body
[
  {
    "location": {
      "type": "Point",
      "coordinates": [
        -0.35335350000002563,
        53.7519168
      ]
    },
    "auctionFee": {
      "unit": "fixed",
      "value": 0,
      "minimum": 0
    },
    "finaliseState": {
      "notifiedBiddersUnsold": true,
      "notifiedAuctioneer": false,
      "notifiedAuctioneerUnsold": false,
      "notifiedBuyersSolicitorSold": false,
      "notifiedSellersSolicitorSold": false,
      "notifiedUnsuccessfulBidders": false,
      "notifiedWinner": false,
      "paymentProcessed": false
    },
    "type": "Other",
    "auctionType": "traditional",
    "startPrice": 81000,
    "thumbnailImage": "https://s3-eu-west-1.amazonaws.com/bamboo-cdn/property/img/qwGg8ArTWo0utZsnnqRkgCOsT-thumbnail.png",
    "preauction": false,
    "amenities": [
      "Barn conversion "
    ],
    "status": "published",
    "watchListCount": 5,
    "organisation": "cliveemson",
    "isVatApplicable": false,
    "statusRank": 4,
    "title": "Property development",
    "description": "Planning has been granted to convert this former stable/hayloft into a 5 bedroom let all with ensuites , communal kitchen/ lounge, balcony gch, double glazing. Or you could purchase this and 46 Hutt st which is situated in front of this development this is a 4 bedroom let at £90,000",
    "numberOfBedrooms": "5+",
    "numberOfReceptions": "1",
    "numberOfBathrooms": "3+",
    "otherNotes": "",
    "auctionLength": 30,
    "addressLineOne": "46b",
    "addressLineTwo": "Hutt Street ",
    "city": "Hull",
    "postcode": "HU3 IQI",
    "commissionDetails": "",
    "galleryImages": [
      {
        "label": "",
        "isThumbnail": true,
        "_id": "5964eb41a8984f0004e9b71d",
        "url": "https://s3-eu-west-1.amazonaws.com/bamboo-cdn/property/img/3T2TwvjQqPitnqXbiuTq62NsP-gallery.JPG"
      }
    ],
    "floorplanImages": [],
    "viewingDates": [],
    "documents": [],
    "featuredImage": "/img/1920x780.gif",
    "numberOfBids": 1,
    "tags": [],
    "openHouseCount": 0,
    "bids": [
      {
        "amount": 81000,
        "avatarColor": "#c11376",
        "avatarInitial": "S",
        "createdAt": "2020-02-17T09:41:55.752Z",
        "status": "expired"
      },
      {
        "amount": 83000,
        "avatarColor": "#084489",
        "avatarInitial": "W",
        "createdAt": "2020-02-17T09:42:15.675Z",
        "status": "expired"
      },
      {
        "amount": 85000,
        "avatarColor": "#c11376",
        "avatarInitial": "S",
        "createdAt": "2020-02-17T11:27:43.003Z",
        "status": "expired"
      },
      {
        "amount": 87000,
        "avatarColor": "#084489",
        "avatarInitial": "W",
        "createdAt": "2020-02-18T12:47:08.114Z",
        "status": "expired"
      },
      {
        "amount": 89000,
        "avatarColor": "#b26411",
        "avatarInitial": "E",
        "createdAt": "2020-02-18T12:47:49.224Z",
        "status": "expired"
      },
      {
        "amount": 91000,
        "avatarColor": "#084489",
        "avatarInitial": "W",
        "createdAt": "2020-02-18T12:48:01.271Z",
        "status": "expired"
      },
      {
        "amount": 82000,
        "avatarColor": "#17015e",
        "avatarInitial": "A",
        "createdAt": "2021-04-12T21:26:06.805Z",
        "status": "active"
      }
    ],
    "handle": "devl-5419089",
    "highestBid": 82000,
    "startingPrice": 81000,
    "guidePrice": 81000,
    "legalFee": 0,
    "adminFee": 0,
    "holdingDeposit": 5000,
    "endDate": "2021-04-16T15:15:00.000Z",
    "previewURL": "http://develop.127.0.0.1:undefined/property/devl-5419089",
    "isReserveMet": false,
    "activeBids": [
      {
        "winningBid": false,
        "isBuyer": true,
        "_id": "6074baeee57b821c5eabf7fd",
        "amount": 82000,
        "avatarColor": "#17015e",
        "avatarInitial": "A",
        "cardId": "pm_1IbLCAJalVV8X0QfO7V799D5",
        "createdAt": "2021-04-12T21:26:06.805Z",
        "solicitorId": "60630cc911af44c3cfd7f161",
        "status": "active",
        "user": "605092eeb076127a991af520"
      }
    ],
    "fullAddress": "46b, Hutt Street , Hull, HU3 IQI",
    "id": "55facd8dad3adf0300ac2b59"
  },
  {
    "location": {
      "type": "Point",
      "coordinates": [
        -1.174814,
        50.8523148
      ]
    },
    "auctionFee": {
      "unit": "fixed",
      "value": 0,
      "minimum": 0
    },
    "finaliseState": {
      "notifiedBiddersUnsold": false,
      "notifiedAuctioneer": false,
      "notifiedAuctioneerUnsold": false,
      "notifiedBuyersSolicitorSold": false,
      "notifiedSellersSolicitorSold": false,
      "notifiedUnsuccessfulBidders": false,
      "notifiedWinner": false,
      "paymentProcessed": false
    },
    "type": "Commercial",
    "auctionType": "traditional",
    "startPrice": 300000,
    "thumbnailImage": "https://s3-eu-west-1.amazonaws.com/bamboo-cdn-staging/property/img/66fecb55-d89a-4ee2-86da-29536430f177.png",
    "preauction": false,
    "amenities": [],
    "status": "published",
    "watchListCount": 1,
    "organisation": "cliveemson",
    "isVatApplicable": false,
    "statusRank": 1,
    "lot": "115",
    "remoteReference": "31395",
    "title": "2,650 Sq. Ft. Town Centre Commercial Building Including Upper Parts With Potential",
    "description": "The building is situated in a prominent trading position on the northern side of West Street, close to the under cover Fareham Shopping Centre and a short distance from the landmark Lloyds TSB building.  \n\nThe ground floor is at present arranged as a main trading area with ancillary space beyond totalling 191 sq.m. (850 sq.ft.) of usable space. On the first floor there is a further 168 sq.m. (1,800 sq.ft.) of office space and store rooms.  \n\nTo the rear is a small courtyard garden with the benefit of pedestrian access, which accesses the building at the point of the rear staircase. This could provide self-contained access to the first floor if required.  \n\nIt is considered that the first floor offers scope and potential for conversion to other uses, including residential, subject to all necessary consents being obtainable.  \n\nInterested applicants are advised to make their own enquiries with the Local Planning Authority, Fareham Borough Council. Tel: 01329 236100\\. Website: fareham.gov.uk.  \n\n**Ground Floor**  \nMain sales area and ancillary storage.  \n\n**First Floor**  \nLargely open-plan office space with store rooms, kitchen and cloakroom with W.C.  \n\n**Outside**  \nThere is a small courtyard to the rear.  \n\n**EPC**  \nThe unit has an EPC rating of 67 (Band C).  \n\n**Freehold with Vacant Possession**  \n\n**Joint Auctioneer**  \n\nT Colyer Esq, Messrs Eddisons, 31st Floor, 40 Bank Street, LONDON, E14 5NR, 020 7516 1614",
    "numberOfBedrooms": "0",
    "numberOfBathrooms": "1",
    "numberOfReceptions": "1",
    "guidePrice": 320000,
    "addressLineOne": "19 West Street",
    "city": "Hampshire",
    "addressLineTwo": "Fareham",
    "postcode": "PO16 0BG",
    "handle": "2650-sq-ft-town-centre-commercial-building-including-upper-parts-with-potential-7885406",
    "bids": [
      {
        "amount": 300000,
        "avatarColor": "#0ba845",
        "avatarInitial": "E",
        "createdAt": "2021-05-13T08:36:43.933Z",
        "status": "active"
      },
      {
        "amount": 305000,
        "avatarColor": "#0c527a",
        "avatarInitial": "N",
        "createdAt": "2021-05-13T08:39:15.863Z",
        "status": "active"
      }
    ],
    "viewingDates": [
      {
        "_id": "5e4d30146c93a7000440b162",
        "date": "2020-02-22T00:00:00.000Z",
        "startTime": "2:00 pm",
        "endTime": "3:00 pm"
      }
    ],
    "documents": [],
    "floorplanImages": [],
    "galleryImages": [
      {
        "label": "",
        "isThumbnail": false,
        "_id": "5967556ce9b3220004a287b5",
        "remoteReference": "",
        "url": "https://s3-eu-west-1.amazonaws.com/bamboo-cdn-staging/property/img/b721310a-9473-46d4-a280-03e8b08ec1e9.png"
      },
      {
        "label": "",
        "isThumbnail": true,
        "_id": "5967556ce9b3220004a287b6",
        "remoteReference": "",
        "url": "https://s3-eu-west-1.amazonaws.com/bamboo-cdn-staging/property/img/04cc4cc0-5887-4ffe-afb7-4b19819370a2.png"
      },
      {
        "label": "",
        "isThumbnail": false,
        "_id": "5967556ce9b3220004a287b7",
        "remoteReference": "",
        "url": "https://s3-eu-west-1.amazonaws.com/bamboo-cdn-staging/property/img/19301389-8940-4dd9-a522-34dabdae6d02.png"
      }
    ],
    "legalFee": 0,
    "adminFee": 0,
    "jointAgent": "59cb61978f5e320004444693",
    "endDate": "2021-05-30T21:00:00.000Z",
    "holdingDeposit": 5000,
    "previewURL": "http://develop.127.0.0.1:undefined/property/2650-sq-ft-town-centre-commercial-building-including-upper-parts-with-potential-7885406",
    "isReserveMet": false,
    "highestBid": 305000,
    "numberOfBids": 2,
    "activeBids": [
      {
        "winningBid": false,
        "isBuyer": false,
        "_id": "609ce51b6b928d69c88c2473",
        "amount": 300000,
        "avatarColor": "#0ba845",
        "avatarInitial": "E",
        "cardId": "fakeId",
        "createdAt": "2021-05-13T08:36:43.933Z",
        "status": "active",
        "user": "5bdad000ae601b00047304dc"
      },
      {
        "winningBid": false,
        "isBuyer": false,
        "_id": "609ce5b3416ee06a9c0034e8",
        "amount": 305000,
        "avatarColor": "#0c527a",
        "avatarInitial": "N",
        "cardId": "fakeId",
        "createdAt": "2021-05-13T08:39:15.863Z",
        "status": "active",
        "user": "5bdad000ae601b00047304dc"
      }
    ],
    "fullAddress": "19 West Street, Fareham, Hampshire, PO16 0BG",
    "id": "5967556ce9b3220004a287b4"
  }
]

List All Properties
GET/api/property

URI Parameters
HideShow
token
string (required) 

bearer token retrieved from /token request.


Property

GET /api/property/property_id
Requestsexample 1
Headers
Authorization: Bearer {token}
Content-Type: application/json
Accept-Version: 1.0.0
Responses200
Headers
Content-Type: application/json
Body
{
  "location": {
    "type": "Point",
    "coordinates": [
      -0.35335350000002563,
      53.7519168
    ]
  },
  "auctionFee": {
    "unit": "fixed",
    "value": 0,
    "minimum": 0
  },
  "finaliseState": {
    "notifiedBiddersUnsold": true,
    "notifiedAuctioneer": false,
    "notifiedAuctioneerUnsold": false,
    "notifiedBuyersSolicitorSold": false,
    "notifiedSellersSolicitorSold": false,
    "notifiedUnsuccessfulBidders": false,
    "notifiedWinner": false,
    "paymentProcessed": false
  },
  "type": "Other",
  "auctionType": "traditional",
  "startPrice": 82000,
  "thumbnailImage": "https://s3-eu-west-1.amazonaws.com/bamboo-cdn/property/img/qwGg8ArTWo0utZsnnqRkgCOsT-thumbnail.png",
  "preauction": false,
  "amenities": [
    "Barn conversion "
  ],
  "status": "published",
  "watchListCount": 5,
  "organisation": "cliveemson",
  "isVatApplicable": false,
  "statusRank": 4,
  "title": "Property development",
  "description": "Planning has been granted to convert this former stable/hayloft into a 5 bedroom let all with ensuites , communal kitchen/ lounge, balcony gch, double glazing. Or you could purchase this and 46 Hutt st which is situated in front of this development this is a 4 bedroom let at £90,000",
  "numberOfBedrooms": "5+",
  "numberOfReceptions": "1",
  "numberOfBathrooms": "3+",
  "otherNotes": "",
  "auctionLength": 30,
  "addressLineOne": "46b",
  "addressLineTwo": "Hutt Street ",
  "city": "Hull",
  "postcode": "HU3 IQI",
  "commissionDetails": "",
  "galleryImages": [
    {
      "label": "",
      "isThumbnail": true,
      "_id": "5964eb41a8984f0004e9b71d",
      "url": "https://s3-eu-west-1.amazonaws.com/bamboo-cdn/property/img/3T2TwvjQqPitnqXbiuTq62NsP-gallery.JPG"
    }
  ],
  "floorplanImages": [],
  "viewingDates": [],
  "featuredImage": "/img/1920x780.gif",
  "numberOfBids": 1,
  "tags": [],
  "openHouseCount": 0,
  "bids": [
    {
      "avatarInitial": "A",
      "avatarColor": "#17015e",
      "amount": 82000,
      "status": "active",
      "user": {
        "id": "0",
        "name": "N/A",
        "email": "N/A"
      }
    }
  ],
  "handle": "devl-5419089",
  "highestBid": 82000,
  "startingPrice": 81000,
  "guidePrice": 81000,
  "legalFee": 0,
  "adminFee": 0,
  "holdingDeposit": 5000,
  "endDate": "2021-04-16T15:15:00.000Z",
  "previewURL": "http://develop.127.0.0.1:undefined/property/devl-5419089",
  "isReserveMet": false,
  "activeBids": [
    {
      "winningBid": false,
      "isBuyer": true,
      "_id": "6074baeee57b821c5eabf7fd",
      "amount": 82000,
      "avatarColor": "#17015e",
      "avatarInitial": "A",
      "cardId": "pm_1IbLCAJalVV8X0QfO7V799D5",
      "createdAt": "2021-04-12T21:26:06.805Z",
      "solicitorId": "60630cc911af44c3cfd7f161",
      "status": "active",
      "user": "605092eeb076127a991af520"
    }
  ],
  "fullAddress": "46b, Hutt Street , Hull, HU3 IQI",
  "id": "55facd8dad3adf0300ac2b59",
  "branchSellers": [
    {
      "name": "Clive Emson Auctioneers"
    },
    {
      "name": "Clive Emson - Sussex"
    },
    {
      "name": "Clive Emson - Hampshire"
    },
    {
      "name": "Clive Emson - West Country"
    },
    {
      "name": "Clive Emson - Essex"
    }
  ],
  "organisationDetails": {
    "isBambooMarketingAllowed": true,
    "conditionalAuctionFee": {
      "unit": "percentage",
      "_id": "5f43a2e895a53f0004114f72",
      "value": 2,
      "minimum": 4000
    },
    "traditionalAuctionFeeLB": {
      "unit": "fixed",
      "_id": "5f43a2e895a53f0004114f70",
      "value": 0,
      "minimum": 0
    },
    "traditionalAuctionFeeHB": {
      "unit": "fixed",
      "_id": "5f43a2e895a53f0004114f71",
      "value": 0,
      "minimum": 0
    },
    "traditionalHoldingDepositHB": 5000,
    "traditionalHoldingDepositLB": 5000,
    "demoMode": false,
    "guidesVisibility": true,
    "isPremium": true,
    "isEmailValidated": true,
    "hideLegalDocs": true,
    "name": "cliveemson",
    "display": "Clive Emson Auctioneers",
    "skipHome": true,
    "externalAddress": "https://www.cliveemson.co.uk/online/",
    "contactName": "James Emson",
    "logoUrl": "https://s3-eu-west-1.amazonaws.com/bamboo-cdn-staging/customers/cliveemson.png",
    "depositToSolicitor": false,
    "email": "hello@bambooauctions.com"
  },
  "isBookmarked": false,
  "isHighestBidder": false,
  "hasBidOnProperty": false,
  "increment": 2000,
  "minimumAllowableBid": 84000,
  "suggestedBid": 84000
}

View a Property Detail
GET/api/property/{property_id}

URI Parameters
HideShow
property_id
number (required) 

ID of the Property in the form of an integer

token
string (required) 

bearer token retrieved from /token request.


DELETE /api/property/property_id
Requestsexample 1
Headers
Authorization: Bearer {token}
Content-Type: application/json
Accept-Version: 1.0.0
Responses204
This response has no content.

Delete a Property
DELETE/api/property/{property_id}

URI Parameters
HideShow
property_id
number (required) 

ID of the Property in the form of an integer

token
string (required) 

bearer token retrieved from /token request.


PUT /api/property/property_id
Requestsexample 1
Headers
Authorization: Bearer {token}
Content-Type: application/json
Accept-Version: 1.0.0
Body
{
  "startPrice": 82000
}
Responses200
Headers
Content-Type: application/json
Body
{
  "location": {
    "type": "Point",
    "coordinates": [
      -0.35335350000002563,
      53.7519168
    ]
  },
  "auctionFee": {
    "unit": "fixed",
    "value": 0,
    "minimum": 0
  },
  "finaliseState": {
    "notifiedBiddersUnsold": true,
    "notifiedAuctioneer": false,
    "notifiedAuctioneerUnsold": false,
    "notifiedBuyersSolicitorSold": false,
    "notifiedSellersSolicitorSold": false,
    "notifiedUnsuccessfulBidders": false,
    "notifiedWinner": false,
    "paymentProcessed": false
  },
  "type": "Other",
  "auctionType": "traditional",
  "startPrice": 82000,
  "thumbnailImage": "https://s3-eu-west-1.amazonaws.com/bamboo-cdn/property/img/qwGg8ArTWo0utZsnnqRkgCOsT-thumbnail.png",
  "preauction": false,
  "amenities": [
    "Barn conversion "
  ],
  "status": "published",
  "watchListCount": 5,
  "organisation": "cliveemson",
  "isVatApplicable": false,
  "statusRank": 4,
  "title": "Property development",
  "description": "Planning has been granted to convert this former stable/hayloft into a 5 bedroom let all with ensuites , communal kitchen/ lounge, balcony gch, double glazing. Or you could purchase this and 46 Hutt st which is situated in front of this development this is a 4 bedroom let at £90,000",
  "numberOfBedrooms": "5+",
  "numberOfReceptions": "1",
  "numberOfBathrooms": "3+",
  "otherNotes": "",
  "auctionLength": 30,
  "addressLineOne": "46b",
  "addressLineTwo": "Hutt Street ",
  "city": "Hull",
  "postcode": "HU3 IQI",
  "commissionDetails": "",
  "galleryImages": [
    {
      "label": "",
      "isThumbnail": true,
      "_id": "5964eb41a8984f0004e9b71d",
      "url": "https://s3-eu-west-1.amazonaws.com/bamboo-cdn/property/img/3T2TwvjQqPitnqXbiuTq62NsP-gallery.JPG"
    }
  ],
  "floorplanImages": [],
  "viewingDates": [],
  "documents": [],
  "featuredImage": "/img/1920x780.gif",
  "numberOfBids": 1,
  "tags": [],
  "openHouseCount": 0,
  "bids": [
    {
      "amount": 81000,
      "avatarColor": "#c11376",
      "avatarInitial": "S",
      "createdAt": "2020-02-17T09:41:55.752Z",
      "status": "expired"
    },
    {
      "amount": 83000,
      "avatarColor": "#084489",
      "avatarInitial": "W",
      "createdAt": "2020-02-17T09:42:15.675Z",
      "status": "expired"
    },
    {
      "amount": 85000,
      "avatarColor": "#c11376",
      "avatarInitial": "S",
      "createdAt": "2020-02-17T11:27:43.003Z",
      "status": "expired"
    },
    {
      "amount": 87000,
      "avatarColor": "#084489",
      "avatarInitial": "W",
      "createdAt": "2020-02-18T12:47:08.114Z",
      "status": "expired"
    },
    {
      "amount": 89000,
      "avatarColor": "#b26411",
      "avatarInitial": "E",
      "createdAt": "2020-02-18T12:47:49.224Z",
      "status": "expired"
    },
    {
      "amount": 91000,
      "avatarColor": "#084489",
      "avatarInitial": "W",
      "createdAt": "2020-02-18T12:48:01.271Z",
      "status": "expired"
    },
    {
      "amount": 82000,
      "avatarColor": "#17015e",
      "avatarInitial": "A",
      "createdAt": "2021-04-12T21:26:06.805Z",
      "status": "active"
    }
  ],
  "handle": "devl-5419089",
  "highestBid": 82000,
  "startingPrice": 81000,
  "guidePrice": 81000,
  "legalFee": 0,
  "adminFee": 0,
  "holdingDeposit": 5000,
  "endDate": "2021-04-16T15:15:00.000Z",
  "previewURL": "http://develop.127.0.0.1:undefined/property/devl-5419089",
  "isReserveMet": false,
  "activeBids": [
    {
      "winningBid": false,
      "isBuyer": true,
      "_id": "6074baeee57b821c5eabf7fd",
      "amount": 82000,
      "avatarColor": "#17015e",
      "avatarInitial": "A",
      "cardId": "pm_1IbLCAJalVV8X0QfO7V799D5",
      "createdAt": "2021-04-12T21:26:06.805Z",
      "solicitorId": "60630cc911af44c3cfd7f161",
      "status": "active",
      "user": "605092eeb076127a991af520"
    }
  ],
  "fullAddress": "46b, Hutt Street , Hull, HU3 IQI",
  "id": "55facd8dad3adf0300ac2b59"
}

Update an Existing Property
PUT/api/property/{property_id}

URI Parameters
HideShow
property_id
number (required) 

ID of the Property in the form of an integer

token
string (required) 

bearer token retrieved from /token request.


Property Images

Property images can be created, read and deleted only.

POST /api/property/image
Requestsexample 1
Headers
Authorization: Bearer {token}
Content-Type: application/json
Accept-Version: 1.0.0
Body
{
  "image_url": "http://thecatapi.com/api/images/get?format=src&type=png",
  "is_thumbnail": true,
  "label": "Cat house"
}
Responses201
Headers
Content-Type: application/json
Body
{
  "url": "https://s3-eu-west-1.amazonaws.com/bamboo-cdn-staging/property/img/6c2b4c9f-a9f9-4fbf-8b17-456c7ccc7530.png",
  "_id": "57239321ee4c4fbb2eaf33c5",
  "isThumbnail": true,
  "label": "Cat house"
}

Upload a Property Image - Hosted File
POST/api/property/image

An image is uploaded to Bamboo Auctions by passing its URL location. In addition a flag, is_thumbnail, can be passed to also make it the thumbnail image in the search results.


POST /api/property/image
Requestsexample 1
Headers
Authorization: Bearer {token}
Content-Type: multipart/form
Accept-Version: 1.0.0
Body
"file" : {the file to upload}
"is_thumbnail": false,
"label": "Cat house"
Responses201
Headers
Content-Type: application/json
Body
{
  "url": "https://s3-eu-west-1.amazonaws.com/bamboo-cdn-staging/property/img/6c2b4c9f-a9f9-4fbf-8b17-456c7ccc7530.png",
  "_id": "57239321ee4c4fbb2eaf33c5",
  "isThumbnail": true,
  "label": "Cat house"
}

Upload a Property Image - Local File
POST/api/property/image

An image can also be uploaded to Bamboo Auctions as a part of a multi-part form upload, directly, instead of via a URL.


GET /api/property/image
Requestsexample 1
Headers
Authorization: Bearer {token}
Content-Type: application/json
Accept-Version: 1.0.0
Responses200
Headers
Content-Type: application/json
Body
[
  {
    "url": "https://s3-eu-west-1.amazonaws.com/bamboo-cdn-staging/property/img/6c2b4c9f-a9f9-4fbf-8b17-456c7ccc7530.png",
    "_id": "57239321ee4c4fbb2eaf33c5",
    "isThumbnail": true,
    "label": "Cat house"
  }
]

Retrieve Property Image Details
GET/api/property/image

To retrieve the details of images associated with a property,


DELETE /api/property/image
Requestsexample 1
Headers
Authorization: Bearer {token}
Content-Type: application/json
Accept-Version: 1.0.0
Responses204
This response has no content.

Delete an Image for a Property
DELETE/api/property/image


Property Floorplans

Property floorplans can be created, read and deleted only.

POST /api/property/floorplan
Requestsexample 1
Headers
Authorization: Bearer {token}
Content-Type: application/json
Accept-Version: 1.0.0
Body
{
  "file_url": "http://thecatapi.com/api/images/get?format=src&type=png",
  "label": "Floorplan of cat house"
}
Responses201
Headers
Content-Type: application/json
Body
{
  "file_url": "https://s3-eu-west-1.amazonaws.com/bamboo-cdn-staging/property/img/6c2b4c9f-a9f9-4fbf-8b17-456c7ccc7530.png",
  "_id": "57239321ee4c4fbb2eaf33c5",
  "label": "Floorplan of cat house"
}

Upload a Property Floorplan - Hosted File
POST/api/property/floorplan

You can upload a floorplan to Bamboo Auctions by passing its URL location.


POST /api/property/floorplan
Requestsexample 1
Headers
Authorization: Bearer {token}
Content-Type: multipart/form
Accept-Version: 1.0.0
Body
file : {the file to upload}
label: "Floorplan of cat house"
Responses201
Headers
Content-Type: application/json
Body
{
  "file_url": "https://s3-eu-west-1.amazonaws.com/bamboo-cdn-staging/property/img/6c2b4c9f-a9f9-4fbf-8b17-456c7ccc7530.png",
  "_id": "57239321ee4c4fbb2eaf33c5",
  "label": "Floorplan of cat house"
}

Upload a Property Floorplan - Local File
POST/api/property/floorplan

A floorplan can also be uploaded to Bamboo Auctions as a part of a multi-part form upload, directly, instead of via a URL.


GET /api/property/floorplan
Requestsexample 1
Headers
Authorization: Bearer {token}
Content-Type: application/json
Accept-Version: 1.0.0
Responses200
Headers
Content-Type: application/json
Body
[
  {
    "file_url": "https://s3-eu-west-1.amazonaws.com/bamboo-cdn-staging/property/img/6c2b4c9f-a9f9-4fbf-8b17-456c7ccc7530.png",
    "_id": "57239321ee4c4fbb2eaf33c5",
    "label": "Floorplan of cat house"
  }
]

Retrieve Flooplan Image Details
GET/api/property/floorplan

To retrieve the details of floorplans associated with a property,


DELETE /api/property/floorplan
Requestsexample 1
Headers
Authorization: Bearer {token}
Content-Type: application/json
Accept-Version: 1.0.0
Responses204
This response has no content.

Delete a Floorplan for a Property
DELETE/api/property/floorplan


Property Documents

Property documents can be created, read and deleted only.

The documents make up the legal pack which should be listed with alongside a property. These documents are only available to registered users on the Bamboo Auctions platform.

POST /api/property/document
Requestsexample 1
Headers
Authorization: Bearer {token}
Content-Type: multipart/form
Accept-Version: 1.0.0
Body
file : this file to upload
Responses201
Headers
Content-Type: application/json
Body
{
url: "https://s3-eu-west-1.amazonaws.com/bamboo-cdn-staging/property/img/6c2b4c9f-a9f9-4fbf-8b17-456c7ccc7530.png"
name: "Property EPC"
}

Upload a Property Document
POST/api/property/document

A document is uploaded to Bamboo Auctions slightly differently to images and floorplans. We accept the file as a part of a muli-part form upload, directly, instead of via a URL.


GET /api/property/document
Requestsexample 1
Headers
Authorization: Bearer {token}
Content-Type: application/json
Accept-Version: 1.0.0
Responses200
Headers
Content-Type: application/json
Body
[
{
url: "https://s3-eu-west-1.amazonaws.com/bamboo-cdn-staging/property/img/6c2b4c9f-a9f9-4fbf-8b17-456c7ccc7530.png"
name: "Property EPC"
}
]

Retrieve Property Document Details
GET/api/property/document

To retrieve the details of document associated with a property,


DELETE /api/property/document
Requestsexample 1
Headers
Authorization: Bearer {token}
Content-Type: application/json
Accept-Version: 1.0.0
Responses204
This response has no content.

Delete a Document for a Property
DELETE/api/property/document


Generated by aglio on 25 Mar 2024