API reference / Depository / Broker
List connections
Every linked broker account. Credentials are never returned.
GET
/v1/broker/connections- Authentication
- Bearer token
- Scope
broker:read
Before you integrate
- Credentials are never returned.
Sample code
Set your key in the GRAPPI_API_KEY environment variable. Sample values are placeholders.
curl -sS -X GET 'https://grappi.ai/v1/broker/connections' \ -H "Authorization: Bearer $GRAPPI_API_KEY"
Sample response
{
"request_id": "req_01HZY3K8M2",
"result": {
"supported_brokers": [
"zerodha",
"angel",
"dhan",
"upstox",
"groww",
"motilal",
"fyers",
"shoonya",
"flattrade",
"xts",
"zebu",
"tradesmart",
"arrow"
],
"connections": [
{
"connection_id": "bconn_a1b2c3d4e5f60718",
"broker": "zerodha",
"mode": "live",
"label": "zerodha (live)",
"status": "active",
"created_at": "2026-11-01T05:00:00.000Z"
}
]
}
}Response fields
| Field | Type | Description |
|---|---|---|
supported_brokers | array | Every broker name you can connect. |
connections | array | Your linked accounts. |
connections[].connection_id | string | The connection's id. |
connections[].broker | string | The broker. |
connections[].mode | string | sandbox or live. |
connections[].label | string | The connection's label. |
connections[].status | string | active or revoked. |
connections[].created_at | string | When it was linked, ISO 8601. |
Errors
Every failure has the same shape. A call that fails on our side or at the data source is refunded to your wallet; a "no record found" answer is charged. See the error reference.