This guide covers the steps from receiving an invite to retrieving live data.

Prerequisites

• An invite link from the H2GC team (sent via email or Slack)
• An HTTP client — curl, Postman, or any language's HTTP library

1. Claim an API key

Open the invite link provided by the H2GC team. The link leads to a claim page where an API key can be generated with a single click.

1. Select Claim Your API Key
2. The generated key appears on screen — it begins with sk_live_
3. Copy the key immediately and store it securely (e.g. a secrets manager or .env file)

2. Discover available datasets

Using the generated API key, query the catalog endpoint to retrieve the list of available datasets:

curl -H "x-api-key: sk_live_your_key" \
  https://portal.h2gc.com/api/v1/catalog

{
  "datasets": [
    {
      "name": "ggr_annual",
      "description": "Annual gross gaming revenue by region, country, category, product, and channel",
      "granularity": "annual",
      "dimensions": ["region", "country", "state", "category", "product", "channel", "sub_channel", "fx", "temporal", "calculation", "year"],
      "metrics": ["ggr"]
    }
  ]
}

Each entry contains:

• name — the value to pass as the metric query parameter
• granularity — annual or monthly
• dimensions — fields available for filtering (e.g. country, channel)
• metrics — the numeric values included in each row (e.g. ggr, turnover)

Refer to Available datasets for a comprehensive guide.

3. Query financial data

Pass the dataset name as the metric parameter. Dimension filters can be added to narrow the result set:

curl -H "x-api-key: sk_live_your_key" \
  "https://portal.h2gc.com/api/v1/financials?metric=ggr_annual&country=United+Kingdom&limit=5"

Each row in the response is split into dimensions (the attributes describing the row) and values (the numeric data):

{
  "meta": {
    "dataset": "ggr_annual",
    "metric": "ggr_annual",
    "granularity": "annual",
    "filters_applied": { "country": ["United Kingdom"] },
    "row_count": 5
  },
  "data": [
    {
      "dimensions": {
        "region": "Europe",
        "country": "United Kingdom",
        "category": "Betting",
        "product": "Sports Betting",
        "channel": "Online",
        "year": 2020
      },
      "values": { "ggr": 3200000000 }
    }
  ],
  "pagination": {
    "cursor": "eyJvIjo1fQ",
    "has_more": true
  }
}

4. Handle pagination

When has_more is true, pass the cursor value from the response to retrieve the next page:

curl -H "x-api-key: sk_live_your_key" \
  "https://portal.h2gc.com/api/v1/financials?metric=ggr_annual&country=United+Kingdom&limit=5&cursor=eyJvIjo1fQ"

The same filters should be maintained across pages. Continue paginating until has_more is false. See the Pagination guide for further details.

Data freshness

H2GC datasets are updated on a monthly cadence. Between updates, query results for the same parameters remain identical. Responses can be safely cached for extended periods — there is no need to re-fetch the same query more than once per month.

Next steps

• Available datasets — dataset catalogue, dimensions, and metrics
• Authentication — API key management and security
• Error handling — error response format and common scenarios
• Rate limits — usage limits and caching guidance
• API Reference — complete endpoint documentation