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>

open or closed. Omit to get both. See Position statuses.

Available options:
open,
closed
limit
integer
default:50

Page size, 1 to 50. Default 50.

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

Positions to skip. Default 0.

Required range: x >= 0

Response

A page of your positions.

Positions, newest first. Only positions with at least one executed order are returned.

status
string
required

Always success on a 200.

Allowed value: "success"
Example:

"success"

data
Position · object[]
required

Your positions with at least one executed order: closed positions first, most recently closed first, then positions that have never closed, newest first.

total
integer
required

Positions matching status, across all pages. It can briefly count a position whose only order is still pending, which data does not return.

Example:

2

included
Included · object

The games, teams, players and leagues the positions' markets reference.

Example:
offset
integer

The offset you sent. Absent when you sent none (the page then starts at 0).

Example:

0

limit
integer

The limit you sent. Absent when you sent none (the page size is then 50).

Example:

50