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.

Response

Your account's trading settings.

Your account's trading settings: the fee on your orders, the maximum trade and whether you can trade. See Fees and order cost.

status
string
required

Always success on a 200.

Allowed value: "success"
Example:

"success"

max_trade
number
required

The maximum trade, in dollars: the most an order may cost in contracts (quantity × price); the fee is not counted. An order over it is refused with 400 Order exceeds the maximum trade of $<limit>; closing a position is never limited. The same for every account. See Fees and order cost.

Example:

100000

state_config
object
required

Display settings the Splash app reads. Always present; not part of the API, so API clients can ignore it.

trading_status
enum<string>

Whether the account can trade. approved: identity verification passed and the account can place orders. pending: verification is under way; orders are refused with 403 Not authorized to trade until it passes. denied: verification failed or the account is suspended, kyc_failure_reason says which, and orders are refused with 403. Omitted when the account has not started verification or has been allowed to start it again, and on a request without the SPLASH-ACCESS-KEY header.

Available options:
approved,
pending,
denied
Example:

"approved"

fee
FeeInfo · object

The fee Splash charges on your orders, which Splash adds to a buy's debit and takes from a close's proceeds. Use it to compute an order's cost before you send it; see Fees and order cost. On a request without the SPLASH-ACCESS-KEY header it is Splash's default fee, not yours. Omitted only if Splash cannot describe the account's fee settings; do not read a missing fee as no fee.

Example:
price_tolerance
integer

A preference set in the Splash app: how many cents above the price shown the user is willing to be filled at, 0 to 10, 0 by default. Orders placed through this API do not read it: an order fills at its own price or better. Present once the user has a Splash trading account (it is created when identity verification starts) and omitted before then.

Required range: 0 <= x <= 10
Example:

0

blocked_sub_categories
enum<string>[]

Leagues the user asked the Splash app to hide, as league ids like nfl. A preference only: POST /trading/orders does not read it, so an order on one of these leagues is not refused for it. Present, as [] when nothing is blocked, once the user has a Splash trading account, and omitted before then. See Leagues.

Available options:
nba,
nfl,
mlb,
nhl,
pga,
nascar,
lol,
csgo,
ncaaf,
tennis,
ncaab,
wnba,
epl,
mls
Example:
kyc_failure_reason
string

Why the account cannot trade, for display: Account suspended, the reason identity verification failed, or KYC verification failed when no reason was recorded. Present only when trading_status is denied.

Example:

"KYC verification failed"

kyc_docv_status
enum<string>

Where the document-verification step stands, for accounts asked for a photo ID check during identity verification. pending: the check has not finished. approved: the check passed. denied: it failed. Omitted when the account was not asked for the check, and whenever trading_status is omitted.

Available options:
pending,
approved,
denied
Example:

"approved"

docv
DocvSession · object

The open document-verification session, so the Splash app can resume it. Present only while trading_status and kyc_docv_status are both pending, and only when Splash could fetch the session.

Example: