Skip to main content
POST
/
v1
/
balance-sheet
/
query
Balance Sheet
curl --request POST \
  --url https://api.bigdata.com/v1/balance-sheet/query \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "identifier": {
    "type": "rp_entity_id",
    "value": "4A6F00"
  },
  "period": "quarter",
  "limit": 20
}
'
{
  "results": {
    "rp_entity_id": "<string>",
    "target_identifier_id": "<string>",
    "fields": [
      "<string>"
    ],
    "values": [
      [
        "<string>"
      ]
    ]
  },
  "errors": [
    {
      "message": "<string>"
    }
  ],
  "metadata": {
    "request_id": "<string>",
    "timestamp": "<string>"
  }
}

Authorizations

X-API-KEY
string
header
required

Body

application/json
identifier
Identifier · object
required

Object specifying which identifier you are using to request the balance sheet. You must supply one type and its corresponding value.

period
enum<string>
default:quarter

Select whether the balance sheet to be provided are on an annual or quarterly basis.

Available options:
annual,
quarter
Example:

"annual"

limit
integer | null
default:20

Maximum number of balance sheets to return. If omitted, all balance sheets are returned.

Example:

20

Response

200 - application/json

Successful Response

results
BalanceSheet · object
required
errors
ErrorDetail · object[] | null
metadata
Metadata · object