Skip to main content
GET
Per-EOA rolling deposit caps + current usage

Authorizations

X-Api-Key
string
header
required

Partner / integrator key — format ps_live_<keyId>_<secret>. Partner keys are issued by PredictStreet; a user can also create keys bound to their own wallet from their account settings in the web app. Never ship to a browser. multi_wallet partners must additionally send X-User-Wallet: 0x<40-hex> on every authenticated request to declare the acting wallet. See the API keys guide for scope taxonomy, partner kinds, rate limits, and rotation procedure.

Headers

X-User-Wallet
string

Required for multi_wallet partners on every authenticated request; ignored for single_wallet. Declares the acting end-user wallet for this request — drives KYC checks, balances/positions/orders attribution, rate-limit buckets, and audit. Lower-cased server-side. Missing on a multi_wallet key → 401 api_key_user_wallet_required; malformed → 401 api_key_user_wallet_invalid. The on-chain CTFExchange/Vault contracts still verify EIP-712 signer ↔ vault binding, so loosening API-layer attribution is safe by construction.

Pattern: ^0x[a-fA-F0-9]{40}$
Example:

"0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb3"

Response

200 - application/json

OK

walletAddress
string
required

Authenticated wallet (lowercase 0x-hex).

tier
enum<integer>
required

The wallet's on-chain DepositLimitRegistry tier — NOT the KYC tier returned by GET /api/me; the two scales differ and must not be compared. Values: 0 = NONE, 1 = TIER_1, 2 = TIER_2, 3 = TIER_3, 4 = VIP, 5 = REJECTED. 0 (NONE) means the on-chain initialisation has not landed yet: deposits revert until it does.

Available options:
0,
1,
2,
3,
4,
5
caps
object
required

Effective caps (the tier default with any per-wallet override applied). These figures, not tier, are what separate one KYC level from another.

used
object
required

Deposits recorded inside each rolling window.

remaining
object
required

Headroom under each rolling cap = cap - used (clamped at 0).

restrictions
object
required

Restriction flags, also enforced on-chain by the vault. A true is not by itself evidence of a compliance action — see each field.