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

FieldTypeDescription
supported_brokersarrayEvery broker name you can connect.
connectionsarrayYour linked accounts.
connections[].connection_idstringThe connection's id.
connections[].brokerstringThe broker.
connections[].modestringsandbox or live.
connections[].labelstringThe connection's label.
connections[].statusstringactive or revoked.
connections[].created_atstringWhen 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.