Get Auctions

Return a list of all auction results for the requested markets.

Definition

Endpoint:
GET https://api.tokendatabase.com/v0.1/markets/auctions/actual
Objects per Hit:
1

Parameters

Name Required Description Available Values Default
before Optional Before time. Returns auctions before the specified time (UTC) A Time Value None
after Optional After time. Returns auctions after the specified time (UTC) A Time Value None
since Optional Since auction id. Returns trades that occur after the auction specified by auction id Any valid auction id None
limit Optional Specifies the max number of auctions to return Any valid integer < 10000 100
ids Required Specifies a list of market ids from which to retrieve auctions A Market ID List
key Required Your API key YOUR_API_KEY

Responses

Name Type Description
id string The unique id used to reference the market on the API
exchange string The exchange id of the market
base string The asset id of the base asset for the market
quote string The asset id of the quote asset for the market
type string The market type of the market
auctions list List of auctions for the requested market
(auctions) id integer The tokendatabase auction id
(auctions) id_on_exchange string The exchange id for an auction
(auctions) event_id_on_exchange string The exchange id for an this particular event
(auctions) time A Time Value The time an auction occurred
(auctions) complete boolean True if this auction has completed
(auctions) best_bid boolean The best bid from the continuous order book at the moment of the auction [only present if complete is true]
(auctions) best_ask boolean The best ask from the continuous order book at the moment of the auction [only present if complete is true]
(auctions) collar_price boolean The price about which any guarantees regarding execution price of the auction are centered [only present if complete is true]
(auctions) success boolean True if this auction was able to proceed while upholding its guarantees [only present if complete is true]
(auctions) price boolean The price at which the auction proceeded [only present if success is true]
(auctions) volume boolean The volume of base asset that was traded in this auction at the given price [only present if success is true]

Example 1

Get the 100 most recent auctions for a given market ids=gemini_spot_btc_usd

https://api1.tokendatabase.com/v0.1/markets/auctions/actual?ids=gemini_spot_btc_usd&key=YOUR_API_KEY

Response

    

Example 2

Get the 2 most recent auctions for a given market that occurred before 2019-02-01 ids=gemini_spot_btc_usd, before=2019-02-01, limit=2

https://api1.tokendatabase.com/v0.1/markets/auctions/actual?ids=gemini_spot_btc_usd&before=2019-02-01&limit=2&key=YOUR_API_KEY

Response

    

Last Modified: 2019-02-01