GET
Get your account
/api/v1/account · needs an API key
Who you are and your cash.
Your user, your main wallet's cash, and every wallet you have: one per private market you joined, each with its own play money. Amounts are in cents: 1,000,000 is T$10,000, what every account starts with. funded is what VPX credited a wallet, so a wallet's profit is its cash plus its positions' value, minus funded.
Request
curl "https://www.vancouverpx.ca/api/v1/account" \
-H "Authorization: Bearer $VPX_API_KEY"Response
200 with this object:
| Field | Type | Description |
|---|---|---|
| userId | string | |
| username | string | null | |
| balance | integer | Main wallet cash, in cents |
| locked | integer | Main wallet cash held by open buy orders |
| available | integer | Main wallet cash you can spend now |
| wallets | Wallet[] | |
| via | object | The API key (or VPX bot) this request came from |
Example
{
"userId": "u_8Kq2mZx4",
"username": "brave-lion-42",
"balance": 1024350,
"locked": 3180,
"available": 1021170,
"wallets": [
{
"id": "clx8w2k3p0001qz8r5t1y7u4v",
"kind": "main",
"marketId": null,
"balance": 1024350,
"locked": 3180,
"available": 1021170,
"funded": 1000000
}
],
"via": {
"kind": "key",
"id": "clz3k9x2a0000ab12cd34ef56",
"name": "Claude Code"
}
}Errors
The errors every endpoint can answer.