Auction
GET/api/v1/auctions
Authorization
bearer_token In: header
Query Parameters
Full-text search query
1-indexed page number
int640 <= valuePage size
int640 <= valueSort field
Sort order (asc or desc)
Value in
- "asc"
- "desc"
Additional filter expressions in the form field:operator:value
Filter by auction status
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" } ], "pagination": { "has_more": true, "page": 0, "page_size": 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
0 <= valueResponse 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" } ], "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}