GET
List my positions

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.

Query Parameters

page
integer
default:1

1-based page number for paginated results.

Required range: x >= 1
limit
integer
default:15

Number of rows per page.

Required range: 1 <= x <= 100
Example:

"earthquake"

startDate
string<date-time>
endDate
string<date-time>
isSettled
boolean

Filter by settlement status (boolean). Standardized across all endpoints.

isClosed
enum<string>

Filter on whether the position is closed — the user holds no contracts, or the market was closed to trading. Passing true additionally restricts the result to positions that still hold contracts, so it answers "closed market, contracts intact" rather than returning every position the user has ever emptied. Omit for the live-holdings default.

Available options:
true,
false

Response

Positions returned.

data
object
errors
array