API reference / Depository / Broker

Broker profile

Client id, name and email of the account behind a broker connection.

GET/v1/broker/profile
Authentication
Bearer token
Scope
broker:read

Before you integrate

  • Send connection_id, or broker for a quick sandbox test. With neither, the call is refused.

Query parameters

FieldTypeRequiredDescription
connection_idstringNoThe connection to use, as returned by connect (3 to 64 characters). Send this or broker.
brokerstringNoQuick sandbox test with no connection, by broker name (2 to 30 characters). One of: zerodha, angel, dhan, upstox, groww, motilal, fyers, shoonya, flattrade, xts, zebu, tradesmart, arrow. Send this or connection_id.

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/profile?broker=zerodha' \
  -H "Authorization: Bearer $GRAPPI_API_KEY"

Sample response

{
  "request_id": "req_01HZY3K8M2",
  "result": {
    "client_id": "AB1234",
    "name": "ASHA RAO",
    "email": "asha.rao@example.com",
    "broker": "zerodha"
  }
}

Response fields

FieldTypeDescription
client_idstringThe account's client id at the broker.
namestringAccount holder's name.
emailstringAccount holder's email.
brokerstringThe broker.

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.