GET
Get my position in a market

Authorizations

Authorization
string
header
required

The end user's JWT access token, sent as Authorization: Bearer <token>.

Obtain one from POST /partner/customers or POST /partner/customers/login — both return it as token. It identifies which of your users a call is made for, and is sent alongside your X-API-Key on every authenticated endpoint.

Event discovery, categories, subcategories and scores are public and need no token.

X-API-Key
string
header
required

ISV / partner credential — public half. Required on every request.

Identifies the integration partner (ISV) making the call. Issued by Dime Trades when the ISV is onboarded and sent on every /partner/* endpoint:

  • On the two partner endpoints that create accounts or issue tokens (POST /partner/customers, POST /partner/customers/login), it is accompanied by X-API-Secret and is the only authentication — there is no user token yet.
  • On every other partner endpoint it is sent alongside the user's Authorization: Bearer <token>: the API key says which platform is calling, the bearer token says which user it is calling for.

Credentials are scoped to one or more brands; using a key with a brandId outside that scope returns 403. Staging and production keys are separate. The key identifies your platform — treat it as a backend credential.

Path Parameters

marketId
number
required
Example:

60497

Response

Market position returned (zero-valued if the user holds no position).

data
PositionMarketScoped · object

The flatter shape returned by GET /positions/market/{marketId} (GetMarketPositionService) — a single market's position with the locked/available contract split. When the user holds no position in the market, a zero-valued object is returned instead of 404; in that case totalFeesPaid and lastUpdatedAt are omitted entirely (not null).

Units: per-contract prices are cents (integers 1–99); every cost, value, fee and P&L figure is dollars (decimal, 2 places). Contract counts are plain integers. See Conventions → Money and units.

errors
array