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.

Path Parameters

id
string
required

The position id (prefix pos_). Another account's position is a 404.

Query Parameters

status
enum<string>

Optional. Return the position only if its status is this: open or closed. A position whose status does not match is a 404. See Position statuses.

Available options:
open,
closed
offset
integer

Optional, 0 or more. Echoed back as offset in the response; it does not page orders, which always lists every order.

Required range: x >= 0
limit
integer

Optional, 1 to 50. Echoed back as limit in the response; it does not page orders.

Required range: 1 <= x <= 50

Response

The position and its orders, newest first.

One position with its orders.

status
string
required

Always success on a 200.

Allowed value: "success"
Example:

"success"

position
PositionDetail · object
required

The position and its orders.

Example:
included
Included · object

The game, teams, player and league the position's market references.

Example:
offset
integer

Echo of an offset query parameter when one was sent; absent otherwise. It does not page orders.

Example:

0

limit
integer

Echo of a limit query parameter when one was sent; absent otherwise. It does not page orders.

Example:

50