---
title: "Usage"
method: GET
path: "/{country}/usage/detailed"
tags: ["International"]
---

# Usage

`GET /{country}/usage/detailed`

## Request

- Base URL: `https://app.regrid.com/api/v2`
- URL: `https://app.regrid.com/api/v2/{country}/usage/detailed`
- Auth: one of:
  - API key in header `x-regrid-token`
  - API key in query parameter `token`

Check your current API usage stats to see how many requests, parcel records, and tiles have been used. You can see full history with using the parameter 'return_full_history' or specify a specific date range.

## Path parameters

- `country` 'ca' | 'ch' | 'cy' | 'cz' | 'de' | 'dk' | 'ee' | 'es' | 'fi' | 'fr' | 'gb' | 'ie' | 'is' | 'it' | 'lu' | 'lv' | 'nl' | 'no' | 'pl' | 'si' | 'sk', required

## Query parameters

- `return_full_history` boolean
- `begin_date` string
- `end_date` string
- `return_by_token` boolean
- `return_by_this_token` boolean

## Response `200`

OK Usage response body

- object
  - `usage` object
    - `cycle_dates` CycleDates
      - `begin` number
      - `end` number
    - `cycle_usage` UsageData
      - `requests` integer
      - `results` integer
      - `tiles` integer
      - `features` integer
      - `typeahead` integer
      - `addresses` integer
      - `buildings` integer
      - `ownership` integer
      - `zoning` integer
      - `area` object
        - `sq_meters` number
        - `acres` number
        - `sq_miles` number
    - `date_range` DateRangeData
      - `begin_ts` number
      - `begin` string, date
      - `end` string, date
      - `total` UsageData
        - `requests` integer
        - `results` integer
        - `tiles` integer
        - `features` integer
        - `typeahead` integer
        - `addresses` integer
        - `buildings` integer
        - `ownership` integer
        - `zoning` integer
        - `area` object
          - `sq_meters` number
          - `acres` number
          - `sq_miles` number
    - `full_history` DateRangeData[]
      - `begin_ts` number
      - `begin` string, date
      - `end` string, date
      - `total` UsageData
        - `requests` integer
        - `results` integer
        - `tiles` integer
        - `features` integer
        - `typeahead` integer
        - `addresses` integer
        - `buildings` integer
        - `ownership` integer
        - `zoning` integer
        - `area` object
          - `sq_meters` number
          - `acres` number
          - `sq_miles` number
    - `by_token` object[]
      - `name` string
      - `token_fragment` string
      - `cycle_usage` UsageData
        - `requests` integer
        - `results` integer
        - `tiles` integer
        - `features` integer
        - `typeahead` integer
        - `addresses` integer
        - `buildings` integer
        - `ownership` integer
        - `zoning` integer
        - `area` object
          - `sq_meters` number
          - `acres` number
          - `sq_miles` number
      - `full_history` DateRangeData[]
        - `begin_ts` number
        - `begin` string, date
        - `end` string, date
        - `total` UsageData
          - `requests` integer
          - `results` integer
          - `tiles` integer
          - `features` integer
          - `typeahead` integer
          - `addresses` integer
          - `buildings` integer
          - `ownership` integer
          - `zoning` integer
          - `area` object
            - `sq_meters` number
            - `acres` number
            - `sq_miles` number

## Other responses

- `401`: Unauthorized

---

[API](https://skmtc.dev/regrid/apis/regrid-global-openapi-specification.md) - [All operations](https://skmtc.dev/regrid/apis/regrid-global-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/regrid/apis/regrid-global-openapi-specification/revisions/0d0765d087c2?raw)