Whiskystats Data API
Whiskystats Data API

Auction

Endpoint:https://data.api.whiskystats.com

Lot Mapping

POST
https://data.api.whiskystats.com
/v01/auction/lot_mapping

Returns the mapped Whisky ID for the requested auction lot number. Also returns the current Whiskybase rating of the Whisky ID.

If the auction lot number is unknown or the lot could not be mapped to a Whisky ID, status code 204 is returned.

Lot MappingHeaders

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Lot MappingRequest Body

  • auction_house_idstring · required

    The Whiskystats identifier number for an auction house. Reach out to Whiskystats to request the auction house ID.

  • auth_codestring · required

    A secret authentication code for each auction house. Reach out to Whiskystats to request the auth code.

  • lot_numberstring · required

    The publicly available identifying number of the lot.

Lot MappingResponses

Data Response

  • lot_numberstring

    The requested lot number for reference.

  • mapped_whisky_idnumber

    The mapped Whisky ID. This can either be a Whiskybase ID (prefix "WB") or a Whiskystats Bottle Group ID (prefix"BG"). See our Documentation for more details.

  • mapped_whiskybase_idstring

    If a Whiskystats Bottle Group was mapped, this is the leading Whiskybase ID of that bottle group.

  • whiskystats_urlstring

    The Whiskystats URL for the mapped Whisky ID.

  • whiskybase_urlstring

    The Whiskybase URL for the mapped Whiskybase ID (the leading Whiskybase ID if mapped to a bottle group).

  • whiskybase_ratingnumber

    The Whiskybase rating of the mapped whisky.

  • whiskybase_rating_countnumber

    The number of Whiskybase ratings of the mapped whisky.


Lot Mappings

POST
https://data.api.whiskystats.com
/v01/auction/lot_mappings

Returns a list of mappings between lot numbers and Whisky IDs for all identified lots of the requested auction. Also returns the current Whiskybase rating of each respective Whisky ID.

If the auction ID is unknown or no lots could be mapped to a Whisky ID, status code 204 is returned.

Lot MappingsHeaders

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Lot MappingsRequest Body

  • auction_house_idstring · required

    The Whiskystats identifier number for an auction house. Reach out to Whiskystats to request the auction house ID.

  • auth_codestring · required

    A secret authentication code for each auction house. Reach out to Whiskystats to request the auth code.

  • auction_idstring · required

    The (auction house internal) auction identifier number.

Lot MappingsResponses

Data Response

  • lot_numberstring

    The requested lot number for reference.

  • mapped_whisky_idnumber

    The mapped Whisky ID. This can either be a Whiskybase ID (prefix "WB") or a Whiskystats Bottle Group ID (prefix"BG"). See our Documentation for more details.

  • mapped_whiskybase_idstring

    If a Whiskystats Bottle Group was mapped, this is the leading Whiskybase ID of that bottle group.

  • whiskystats_urlstring

    The Whiskystats URL for the mapped Whisky ID.

  • whiskybase_urlstring

    The Whiskybase URL for the mapped Whiskybase ID (the leading Whiskybase ID if mapped to a bottle group).

  • whiskybase_ratingnumber

    The Whiskybase rating of the mapped whisky.

  • whiskybase_rating_countnumber

    The number of Whiskybase ratings of the mapped whisky.