H2GC API
DataFinancials
GET
/v1/financials

Authorization

x-api-key<token>

API key obtained by claiming an invite. Format: sk_live_...

In: header

Query Parameters

metricRequiredstring

The dataset/metric to query. Use the /catalog endpoint to discover available metrics.

Minimum length: 1
periodstring

Date range filter in YYYY-MM-DD:YYYY-MM-DD format

Pattern: "^\\d{4}-\\d{2}-\\d{2}:\\d{4}-\\d{2}-\\d{2}$"
granularitystring

Time granularity. Defaults to the dataset's native granularity if omitted.

Value in: "monthly" | "annual"
regionAny properties in string,array<string>

Filter by region(s)

countryAny properties in string,array<string>

Filter by country/countries

channelAny properties in string,array<string>

Filter by distribution channel(s)

categoryAny properties in string,array<string>

Filter by product category/categories

productAny properties in string,array<string>

Filter by specific product(s)

sub_channelAny properties in string,array<string>

Filter by sub-channel(s)

operatorAny properties in string,array<string>

Filter by operator name(s). Applies to market_share datasets.

fx_local_currencyAny properties in string,array<string>

Filter by local currency code(s). Applies to fx dataset.

stateAny properties in string,array<string>

Filter by state/province. Applies to datasets with sub-national data.

fxAny properties in string,array<string>

Filter by currency code(s) (e.g. USD, GBP). Applies to ggr, turnover.

temporalAny properties in string,array<string>

Filter by time classification (e.g. Current, Constant). Applies to ggr, turnover, fx, country.

calculationAny properties in string,array<string>

Filter by calculation method (e.g. Reported, Estimated). Applies to ggr, turnover, fx, country.

limitinteger

Maximum number of rows per page

Minimum: 1Maximum: 1000
cursorstring

Pagination cursor from a previous response

curl -X GET "https://api.beta.h2gc.com/v1/v1/financials?metric=ggr&period=2024-01-01%3A2024-12-31&granularity=monthly&region=Europe&country=string&channel=string&category=string&product=string&sub_channel=string&operator=string&fx_local_currency=string&state=string&fx=string&temporal=string&calculation=string&limit=100&cursor=%3Cstring%3E" \
  -H "x-api-key: <token>"

Financial data matching the query

{
  "meta": {
    "dataset": "string",
    "metric": "string",
    "granularity": "monthly",
    "filters_applied": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "row_count": 0
  },
  "data": [
    {
      "dimensions": {
        "property1": null,
        "property2": null
      },
      "values": {
        "property1": null,
        "property2": null
      }
    }
  ],
  "pagination": {
    "cursor": "string",
    "has_more": true
  }
}

List available datasets

Returns the catalog of all datasets available via the API, including their dimensions, metrics, and granularity.

Query reference data

Retrieve reference datasets that contain no time dimension or numeric metrics (e.g. country_reference). Returns flat rows with cursor-based pagination.