Product
What this group covers
Product endpoints include public homepage and vault views. Points, referrals, and wallet fee reads require account authentication.
The endpoint list below is generated from the canonical OpenAPI specification and kept in sync through CI.
Get homepage product projection
Get homepage product projection
Get dashboard product projection
Get dashboard product projection
List vault product projection rows
The unfiltered vault catalogue remains public. Supplying wallet or address, including an empty value, requires read credentials for that same account. Both selectors must match when supplied together. Omitting both selectors returns the unfiltered catalogue even when credentials are present. Responses must not be cached.
Get points product projection
Requires read scope for the authenticated account. Omitting wallet selects that account. Supplied wallet and address selectors must both match it. Responses are private and must not be cached.
Get referrals product projection
Requires read scope for the authenticated account. Omitting wallet selects that account. Supplied wallet and address selectors must both match it. Responses are private and must not be cached.
Redeem a referral code
Binds the signing wallet to the code owner as its referrer and grants the code's trading concession. The binding is permanent, so the request is wallet-signed rather than session authenticated. A wallet that already has a referrer keeps it and receives the concession; the response reports referrerBound false.
Fee programme statement for a wallet
Requires read scope for the authenticated account. Omitting wallet selects that account. Supplied wallet and address selectors must both match it. Responses are private and must not be cached.
Fee rates currently applied to a wallet
Requires read scope for the authenticated account. Omitting wallet selects that account. Supplied wallet and address selectors must both match it. Responses are private and must not be cached.
Get an app record for its owner
Broker self-service read of one app: display name, status, origins, owner and payout wallets, limit profile and key metadata. Never includes key secrets or their hashes. Authorized for the owner wallet's private read credential (the same bearer or HMAC v2 verification as the account reads) or for the app-key channel (`x-sentico-app-key`, or a FIX/FIXP/BSL logon) resolved to the same `appId`. Responses are private and must not be cached.
Get an app's revenue and activity overview
Revenue (surcharge credits, broker fee-programme share), attributed orders and fills, trader counts, per-market breakdown and limit usage inside the selected range. Authorized for the owner wallet's private read credential or the app-key channel of the same app. Responses are private and must not be cached.
List an app's attributed fills
Taker fills of orders attributed to the app inside the range, newest first, with a stable per-app trader pseudonym instead of the account. With `Accept: text/csv` the same rows are returned as CSV with a header line and the continuation cursor in the `X-Next-Cursor` response header. Authorized for the owner wallet's private read credential or the app-key channel of the same app. Responses are private and must not be cached.
Get current verification state
Get current verification state
Build verification and withdraw-proof state
Build verification and withdraw-proof state