REregrid
Canada

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.

get/ca/usage

Request

  • Base URL
    https://app.regrid.com/api/v2
  • URL
    https://app.regrid.com/api/v2/ca/usage
  • Auth
    • API key in header x-regrid-token
    • or API key in query parameter token

Query parameters

return_full_historyboolean

Set to true if you would like the entire API usage history.

begin_datestring

optional, datatype:date, YYYY/MM/DD returns the usage from the specified beginning date to current date unless 'end_date' is used.

end_datestring

optional, datatype: date, YYYY/MM/DD returns the usage for all usage up until the specified ending date unless 'begin_date' is used and when.

return_by_tokenboolean

optional, returns usage by all available tokens. See by_token array in response of each token's usage data.

return_by_this_tokenboolean

optional, returns usage for only this token.

Response

OK Usage response body

Changes

No recorded changes to this operation across all 2 revisions of this API.