---
title: "Usage"
method: GET
path: "/ca/usage"
tags: ["Canada"]
---

# Usage

`GET /ca/usage`

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.

## 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.net/regrid/apis/regrid-openapi-specification.md) · [All operations](https://skmtc.net/regrid/apis/regrid-openapi-specification/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/regrid/regrid-openapi-specification/versions/e4abb9a7fcfe/schema)