Cash Flow Statement

This endpoint retrieves fundamental cash flow statement measures for a company, including operating, investing, and financing cash flows across reporting periods.

POST /v1/cash-flow-statement/query

Cash Flow Statement

cURL

curl --request POST \
  --url https://api.bigdata.com/v1/cash-flow-statement/query \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "identifier": {
    "type": "rp_entity_id",
    "value": "<string>"
  },
  "period": "quarter",
  "limit": 20
}
'

200

{
  "results": {
    "rp_entity_id": "<string>",
    "target_identifier_id": "<string>",
    "fields": [],
    "values": [
      [
        "<string>",
        "<string>",
        "<string>",
        "<string>",
        123,
        "<string>",
        123,
        123,
        123,
        123,
        123,
        123,
        123,
        123,
        123,
        123,
        123,
        123,
        123,
        123,
        123,
        123,
        123,
        123,
        123,
        123,
        123,
        123,
        123,
        123,
        123,
        123,
        123,
        123,
        123,
        123,
        123,
        123,
        123,
        123,
        123,
        123,
        123,
        123,
        123
      ]
    ]
  },
  "errors": [
    {
      "message": "<string>"
    }
  ],
  "metadata": {
    "request_id": "<string>",
    "timestamp": "<string>"
  }
}

Authorizations

X-API-KEY · string · header · required

Body

application/json

identifier · SingleIdentifier · object · required

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

Show child attributes

Example:

{ "type": "rp_entity_id", "value": "4A6F00" }

period · enum<string> · default: quarter

Select whether the cash flow statement to be provided are on an annual or quarterly basis.

Available options: annual, quarter

Example:

"annual"

limit · integer | null · default: 20

Maximum number of cash flow statements records to return. If omitted, all cash flow statements records are returned.

Example:

20

Response

200 - application/json

Successful Response

results · CashFlowStatement · object · required

CashFlowStatement · object

CashFlowStatement · object[]

Show child attributes

errors · ErrorDetail · object[] | null

Show child attributes

metadata · Metadata · object | null

Show child attributes