Auction
GET/api/v1/auctions
Authorization
bearer_token In: header
Query Parameters
Conditions as filter[][]=. Conditions on different fields all apply. in (any of) and all (every one of, on fields holding several values) take a comma-separated list (\, for a literal comma). exists takes true or false. Datetimes are RFC 3339, now, or a time before now such as -30m, -6h or -7d.
Comma-separated sort keys, - for descending, at most 1. Keys: start_time, end_time, created_at. Default: -created_at.
Rows per page, 1 to 100 (default 25).
1 <= value <= 100The page.next_cursor of the previous page. Cannot be combined with page.
A 1-based page number, for jumping. Cannot be combined with cursor.
1 <= valueSet to true to include the number of matching rows in page.total.
Response Body
application/json
curl -X GET "https://example.com/api/v1/auctions"{ "auctions": [ { "auction_id": "string", "auction_type": "english", "bid_increment": 0.1, "buy_it_now_price": 0, "created_at": "2019-08-24T14:15:22Z", "currency": "string", "current_price": 0.1, "end_time": "2019-08-24T14:15:22Z", "final_price": 0, "high_bidder": "string", "item_id": "string", "reserve_price": 0, "seller_id": "string", "start_time": "2019-08-24T14:15:22Z", "starting_price": 0.1, "status": "scheduled", "total_bids": 0, "updated_at": "2019-08-24T14:15:22Z", "winner_id": "string" } ], "page": { "has_more": true, "next_cursor": "string", "page": 0, "total": 0 }}POST/api/v1/auctions
Authorization
bearer_token In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/api/v1/auctions" \ -H "Content-Type: application/json" \ -d '{ "bid_increment": 0.1, "end_time": "2019-08-24T14:15:22Z", "item_id": "string", "start_time": "2019-08-24T14:15:22Z", "starting_price": 0.1 }'{ "auction_id": "string", "status": "string"}POST/api/v1/auctions/batch
Authorization
bearer_token In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
A batch of auctions to create atomically. If any auction is invalid or
conflicts, none are created (all-or-nothing). The server enforces a
per-batch cap (max_batch_auctions).
Response Body
application/json
curl -X POST "https://example.com/api/v1/auctions/batch" \ -H "Content-Type: application/json" \ -d '{ "auctions": [ { "bid_increment": 0.1, "end_time": "2019-08-24T14:15:22Z", "item_id": "string", "start_time": "2019-08-24T14:15:22Z", "starting_price": 0.1 } ] }'{ "auction_ids": [ "string" ], "count": 0}GET/api/v1/auctions/{auction_id}
Authorization
bearer_token In: header
Path Parameters
Auction identifier
Response Body
application/json
curl -X GET "https://example.com/api/v1/auctions/string"{ "auction_id": "string", "auction_type": "english", "bid_increment": 0.1, "buy_it_now_price": 0, "created_at": "2019-08-24T14:15:22Z", "currency": "string", "current_price": 0.1, "end_time": "2019-08-24T14:15:22Z", "final_price": 0, "high_bidder": "string", "item_id": "string", "reserve_price": 0, "seller_id": "string", "start_time": "2019-08-24T14:15:22Z", "starting_price": 0.1, "status": "scheduled", "total_bids": 0, "updated_at": "2019-08-24T14:15:22Z", "winner_id": "string"}DELETE/api/v1/auctions/{auction_id}
Releases all bid holds; seller or admin only.
Authorization
bearer_token In: header
Path Parameters
Auction identifier
Response Body
application/json
curl -X DELETE "https://example.com/api/v1/auctions/string"{ "auction_id": "string", "holds_released": 0, "message": "string", "status": "scheduled"}GET/api/v1/auctions/{auction_id}/bids
Authorization
bearer_token In: header
Path Parameters
Auction identifier
Query Parameters
Rows per page, 1 to 100 (default 25).
1 <= value <= 100The page.next_cursor of the previous page. Cannot be combined with page.
Set to true to include the number of matching rows in page.total.
Response Body
application/json
curl -X GET "https://example.com/api/v1/auctions/string/bids"{ "bids": [ { "amount": 0.1, "auction_id": "string", "bid_id": "string", "bidder_id": "string", "hold_id": "string", "is_proxy": true, "timestamp": "2019-08-24T14:15:22Z" } ], "page": { "has_more": true, "next_cursor": "string", "page": 0, "total": 0 }}POST/api/v1/auctions/{auction_id}/bids
Authorization
bearer_token In: header
Path Parameters
Auction identifier
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/api/v1/auctions/string/bids" \ -H "Content-Type: application/json" \ -d '{ "amount": 0.1 }'{ "accepted": true, "closed": true, "current_price": 0.1, "message": "string", "your_bid": 0.1}POST/api/v1/auctions/{auction_id}/close
Settles the open auction immediately; seller or admin only.
Authorization
bearer_token In: header
Path Parameters
Auction identifier
Response Body
application/json
curl -X POST "https://example.com/api/v1/auctions/string/close"{ "message": "string", "settlement": { "auction_id": "string", "final_price": 0, "funds_settled": true, "holds_released": 0, "item_transferred": true, "reserve_met": true, "status": "scheduled", "winner_id": "string" }}POST/api/v1/auctions/{auction_id}/proxy-bid
Authorization
bearer_token In: header
Path Parameters
Auction identifier
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/api/v1/auctions/string/proxy-bid" \ -H "Content-Type: application/json" \ -d '{ "max_amount": 0.1 }'{ "current_price": 0.1, "max_amount": 0.1, "message": "string", "success": true}PUT/api/v1/auctions/{auction_id}/status
FSM-guarded transition; seller or admin only.
Authorization
bearer_token In: header
Path Parameters
Auction identifier
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X PUT "https://example.com/api/v1/auctions/string/status" \ -H "Content-Type: application/json" \ -d '{ "status": "string" }'{ "message": "string", "settlement": null, "status": "scheduled", "success": true}