Skip to main content
GET
List sell orders
Two modes on one path:
  • List. Without external_id you get your sell orders placed through the API, newest first, with keyset pagination. The envelope and the query parameters are the same as GET /v1/orders, so one pager reads both your buys and your sells. Walk older pages by passing meta.next_cursor back as cursor.
  • Lookup. With external_id you get that one order object, not a page, or 404 order_not_found.
Reads work for every key, even while Instant Sell is switched off, so you can always follow orders already in flight. Authentication required. Send your key as Authorization: Bearer csb_pub_....

Query parameters

string
Return the one order you created with this external_id. The other parameters are ignored.
integer
default:"50"
Results per page. Minimum 1, maximum 100.
integer
Only orders created at or after this Unix timestamp (seconds).
integer
Only orders created at or before this Unix timestamp (seconds).
string
One of pending, offer_sent, received, completed, cancelled, failed.
string
Keyset cursor from a previous response’s meta.next_cursor.

Response fields

SellOrder[]
required
Sell orders for this page, in the shape described on POST /v1/sell/orders.
object
required

Example request

Example response

Error codes

Authorizations

Authorization
string
header
required

Send your key as a Bearer token on every request: Authorization: Bearer csb_pub_.... Generate keys in your CSBoard profile.

Query Parameters

external_id
string

Look up one order by your external_id. Returns the order object, not a page.

limit
integer
default:50

Results per page. 1 to 100. Default 50.

Required range: 1 <= x <= 100
start_unix_time
integer

Only orders created at or after this Unix timestamp (seconds).

end_unix_time
integer

Only orders created at or before this Unix timestamp (seconds).

status
enum<string>

Filter by order status.

Available options:
pending,
offer_sent,
received,
completed,
cancelled,
failed
cursor
string

Keyset cursor from a previous response's meta.next_cursor.

Response

A page of sell orders, or one order when external_id is set.

data
object[]
required
meta
object
required