Skip to main content
GET
cURL

Authorizations

SPLASH-ACCESS-KEY
string
header
required

Your API key id. Keys are issued by Splash on request, never expire, and stay valid until Splash revokes them, which it does on request. See Authentication.

SPLASH-ACCESS-TIMESTAMP
string
header
required

Unix milliseconds, within 30 seconds of server time.

SPLASH-ACCESS-SIGNATURE
string
header
required

base64(HMAC-SHA256(secret, timestamp + METHOD + path + body)). See Authentication.

Query Parameters

status
enum<string>

Only orders with this status: pending (queued or in flight), executed or cancelled. Omit for every status. See Order statuses.

Available options:
pending,
executed,
cancelled
limit
integer
default:50

Page size, 1 to 50. Default 50.

Required range: 1 <= x <= 50
offset
integer
default:0

Orders to skip, 0 to 100000. Default 0.

Required range: 0 <= x <= 100000
request_id
string

Find the order you placed with this request_id. Use it when you sent Place an order but never received its order_id: the request timed out, the connection dropped, or your client stopped before saving the response. You always know the request_id you sent, so this always finds the order if Splash recorded it, and returns an empty list if it did not (then retrying with the same request_id is safe). While the order is queued, or after it was refused before being recorded, the item is a PendingOrder. 1 to 64 characters from A-Z a-z 0-9 _ -.

Response

Your orders, newest first. With request_id, an order not yet recorded comes back as a PendingOrder in data, without included.

Orders, newest first. With request_id, an order that is not fully recorded yet is a PendingOrder.

status
string
required

Always success on a 200.

Allowed value: "success"
Example:

"success"

data
OrderWithMarket · object[]
required

Your orders, newest first, each an OrderWithMarket. While a polled request_id is queued, or after it was refused before being recorded, the item is a PendingOrder instead.

total
integer
required

Orders matching status (and request_id), across all pages. While a polled order is still a PendingOrder, this is 1 even when data is empty.

Example:

3

offset
integer
required

The offset the page starts at.

Example:

0

limit
integer
required

The page size.

Example:

50

included
Included · object

The games, teams, players and leagues the orders' markets reference. Absent when data holds a PendingOrder.

Example: