Metadata Endpoints
The metadata endpoints provide account-level and dataset-level information that supports your integration with the Regrid API. These endpoints are useful for monitoring your usage, understanding county-level data coverage, reporting data quality issues, and managing your API consumption programmatically. All metadata endpoints require a valid API token. There is no parcel record cost associated with the Verse Table, Usage, or Detailed Usage endpoints.
- Base URL: https://app.regrid.com/api/v2
- Required parameter (all endpoints): token — your Regrid API authorization token.
Verse Table
GET /verse
Returns Regrid's verse table — a county-level metadata table listing every county and geography in the dataset. Each row describes a single administrative area and includes coverage status, last refresh date, parcel count, shapefile size flag, and the availability of add-on data products for that geography.
The verse table is the authoritative reference for understanding what data Regrid has for a given area, when it was last updated, and whether any special handling is needed (such as large shapefile warnings).
Example request
GET https://app.regrid.com/api/v2/verse?token=<token>
Query parameters
return_geometry(optional): Default false. Features are returned without geometry values. This reduces the payload size significantly when only field data is required.
Example API request
`GET https://app.regrid.com/api/v2/us/verse?return_geometry=true
Example response
{
"verse": {
"type": "FeatureCollection",
"features": : [
{
"type": "Feature",
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-96.90121,
42.090481
],
[
-97.368404,
42.090922
],
[
-97.367724,
42.351861
],
[
-97.017789,
42.351347
],
[
-97.01773,
42.264453
],
[
-96.822497,
42.264292
],
[
-96.82367,
42.090411
],
[
-96.90121,
42.090481
]
]
]
},
"properties": {
"id": 1945,
"path": "/us/ne/wayne",
"county": "Wayne",
"state": "NE",
"seat": "Wayne",
"population": 9367,
"sqmi": 444,
"geoid": "31179",
"city": null,
"table_name": "ne_wayne20210209",
"total_objects": 6630,
"last_refresh": "2021-02-15",
"canonical_path": "/us/ne/wayne",
"filename_stem": "ne_wayne",
"date_added": null,
"shapefile_size_flag": null,
"assessor_data_date": "2018-03-01",
"usps_data_date": "2022-01-01"
},
"id": 1945
},
...
]
}When to use it
Use the verse table to build a county picker in your application, identify which geographies have been recently refreshed, generate a list of areas where you need to pull an alternate format due to the 2GB shapefile limit, or verify coverage before making bulk parcel requests.
Canada Metadata (Verse)
api/v2/ca/verse
This endpoint retrieves all records from our verse schema. These records indicate the last time we did a full data pull from the source. Occasionally these records are of cities when that is how data is reported.
Note for bulk data customers: This endpoint may reflect data updates before they are available in bulk files. The verse file included with your bulk data deliveries will always reflect the current state of data available to you.
HTTP API request
GET /api/v2/ca/verse
Query parameters
return_geometry(optional): Default false. Features are returned without geometry values. This reduces the payload size significantly when only field data is required.
Usage
GET /usage
Returns a summary of your current API usage for the active billing period. Shows parcel records consumed versus your plan limit, helping you monitor consumption and avoid unexpected overage charges.
This endpoint has no parcel record cost and can be called as frequently as needed to check your remaining balance in real time.
Example request
GET https://app.regrid.com/api/v2/usage?token=<token>
Query parameters
token: Your Regrid assigned authorization token.return_full_history(optional): Set totrueif you would like API usage history that goes beyond your current monthly cycle.begin_date(optional): Date type formatted asYYYY/MM/DD. Returns the usage from the specified beginning date to current date unlessend_dateis also used.end_date(optional): Date type formatted asYYYY/MM/DD. Returns the usage for all usage up until the specified ending date unlessbegin_dateis also used.return_by_token(optional): Returns usage by all available tokens. See theby_tokenarray in the response for each token's usage data.return_by_this_token(optional): Returns usage for only this token.
Response fields
cycle_dates: The start and end date of the current cycle.cycle_usage: Counts ofrequests,results, andtilesused during the current cycle.full_history: An array of stats for previous cycles. Only included if the optionalreturn_full_historyboolean query parameter is set totrue.by_token: An array of usage data by each token. Keys include tokenname,token_fragment(the last few characters of the token),cycle_usageobject, andfull_historyarray.
Example request:
GET https://app.regrid.com/api/v2/usage?token=<token>&full_history=true
Example response
{
"usage": {
"cycle_dates": {
"begin": 1693269014,
"end": 1695947414
},
"cycle_usage": {
"requests": 710,
"results": 1119,
"tiles": 0,
"typeahead": 2,
"features": 0,
"ownership": 489,
"area": {
"sq_meters": 28646786,
"acres": 7078.775,
"sq_miles": 11.0606
},
"buildings": 129,
"addresses": 1
},
"date_range": {
"begin_ts": 1641038400,
"begin": "2022-1-1",
"end": "2023-9-18",
"total": {
"tiles": 0,
"requests": 1506,
"results": 3774,
"buildings": 10833,
"addresses": 2392,
"typeahead": 8,
"features": 282,
"ownership": 2379,
"area": {
"sq_meters": 28646786,
"acres": 7078.775,
"sq_miles": 11.0606
},
"a_typeahead": 0
}
},
"by_token": [
{
"name": "Automatically Provisioned",
"token_fragment": "...",
"cycle_usage": {...},
"full_history": [...]
}
],
"full_history": [
{
"begin_ts": 1693269014,
"begin": "2023-8-28",
"end": "2023-9-28",
"total": {
"requests": 710,
"results": 1119,
"tiles": 0,
"features": 0,
"addresses": 1150,
"buildings": 1454,
"ownership": 489,
"typeahead": 2,
"area": {
"sq_meters": 28646786,
"acres": 7078.775,
"sq_miles": 11.0606
}
},
"overage": {},
"counts": [
{
"results": 65,
"buildings": 129,
"typeahead": 1,
"requests": 10,
"addresses": 1,
"ownership": 65,
"date": "2023-9-18"
},
{
"date": "2023-9-17",
"requests": 1,
"results": 13,
"tiles": 0,
"buildings": 22,
"addresses": 39,
"typeahead": 0,
"a_typeahead": 0,
"features": 0,
"ownership": 10,
"area": {
"sq_meters": 3460,
"acres": 0.855,
"sq_miles": 0.0013
}
},
{
"date": "2023-9-16",
"requests": 1,
"results": 0,
"tiles": 0,
"buildings": 0,
"addresses": 0,
"typeahead": 0,
"a_typeahead": 0,
"features": 0,
"ownership": 0,
"area": {
"sq_meters": 0,
"acres": 0,
"sq_miles": 0
}
},
{
"date": "2023-9-15",
"requests": 3,
"results": 3,
"tiles": 0,
"buildings": 5,
"addresses": 5,
"typeahead": 0,
"a_typeahead": 0,
"features": 0,
"ownership": 3,
"area": {
"sq_meters": 0,
"acres": 0,
"sq_miles": 0
}
},
{
"date": "2023-9-14",
"requests": 0,
"results": 0,
"tiles": 0,
"buildings": 0,
"addresses": 0,
"typeahead": 0,
"a_typeahead": 0,
"features": 0,
"ownership": 0,
"area": {
"sq_meters": 0,
"acres": 0,
"sq_miles": 0
}
},
{
"date": "2023-9-13",
"requests": 0,
"results": 0,
"tiles": 0,
"buildings": 0,
"addresses": 0,
"typeahead": 0,
"a_typeahead": 0,
"features": 0,
"ownership": 0,
"area": {
"sq_meters": 0,
"acres": 0,
"sq_miles": 0
}
},
{
"date": "2023-9-12",
"requests": 3,
"results": 2,
"tiles": 0,
"buildings": 0,
"addresses": 0,
"typeahead": 0,
"a_typeahead": 0,
"features": 0,
"ownership": 0,
"area": {
"sq_meters": 0,
"acres": 0,
"sq_miles": 0
}
},
{
"date": "2023-9-11",
"requests": 31,
"results": 53,
"tiles": 0,
"buildings": 50,
"addresses": 192,
"typeahead": 0,
"a_typeahead": 0,
"features": 0,
"ownership": 18,
"area": {
"sq_meters": 10380,
"acres": 2.565,
"sq_miles": 0.004
}
},
{
"date": "2023-9-10",
"requests": 0,
"results": 0,
"tiles": 0,
"buildings": 0,
"addresses": 0,
"typeahead": 0,
"a_typeahead": 0,
"features": 0,
"ownership": 0,
"area": {
"sq_meters": 0,
"acres": 0,
"sq_miles": 0
}
},
{
"date": "2023-9-9",
"requests": 0,
"results": 0,
"tiles": 0,
"buildings": 0,
"addresses": 0,
"typeahead": 0,
"a_typeahead": 0,
"features": 0,
"ownership": 0,
"area": {
"sq_meters": 0,
"acres": 0,
"sq_miles": 0
}
},
{
"date": "2023-9-8",
"requests": 0,
"results": 0,
"tiles": 0,
"buildings": 0,
"addresses": 0,
"typeahead": 0,
"a_typeahead": 0,
"features": 0,
"ownership": 0,
"area": {
"sq_meters": 0,
"acres": 0,
"sq_miles": 0
}
},
{
"date": "2023-9-7",
"requests": 529,
"results": 521,
"tiles": 0,
"buildings": 521,
"addresses": 0,
"typeahead": 0,
"a_typeahead": 0,
"features": 0,
"ownership": 0,
"area": {
"sq_meters": 0,
"acres": 0,
"sq_miles": 0
}
},
{
"date": "2023-9-6",
"requests": 35,
"results": 136,
"tiles": 0,
"buildings": 184,
"addresses": 381,
"typeahead": 0,
"a_typeahead": 0,
"features": 0,
"ownership": 115,
"area": {
"sq_meters": 1642936,
"acres": 405.9783,
"sq_miles": 0.6343
}
},
{
"date": "2023-9-5",
"requests": 21,
"results": 55,
"tiles": 0,
"buildings": 110,
"addresses": 12,
"typeahead": 1,
"a_typeahead": 0,
"features": 0,
"ownership": 55,
"area": {
"sq_meters": 0,
"acres": 0,
"sq_miles": 0
}
},
{
"date": "2023-9-4",
"requests": 0,
"results": 0,
"tiles": 0,
"buildings": 0,
"addresses": 0,
"typeahead": 0,
"a_typeahead": 0,
"features": 0,
"ownership": 0,
"area": {
"sq_meters": 0,
"acres": 0,
"sq_miles": 0
}
},
{
"date": "2023-9-3",
"requests": 0,
"results": 0,
"tiles": 0,
"buildings": 0,
"addresses": 0,
"typeahead": 0,
"a_typeahead": 0,
"features": 0,
"ownership": 0,
"area": {
"sq_meters": 0,
"acres": 0,
"sq_miles": 0
}
},
{
"date": "2023-9-2",
"requests": 0,
"results": 0,
"tiles": 0,
"buildings": 0,
"addresses": 0,
"typeahead": 0,
"a_typeahead": 0,
"features": 0,
"ownership": 0,
"area": {
"sq_meters": 0,
"acres": 0,
"sq_miles": 0
}
},
{
"date": "2023-9-1",
"requests": 0,
"results": 0,
"tiles": 0,
"buildings": 0,
"addresses": 0,
"typeahead": 0,
"a_typeahead": 0,
"features": 0,
"ownership": 0,
"area": {
"sq_meters": 0,
"acres": 0,
"sq_miles": 0
}
},
{
"date": "2023-8-31",
"requests": 55,
"results": 153,
"tiles": 0,
"buildings": 255,
"addresses": 502,
"typeahead": 0,
"a_typeahead": 0,
"features": 0,
"ownership": 127,
"area": {
"sq_meters": 132024,
"acres": 32.6238,
"sq_miles": 0.051
}
},
{
"date": "2023-8-30",
"requests": 16,
"results": 116,
"tiles": 0,
"buildings": 174,
"addresses": 16,
"typeahead": 0,
"a_typeahead": 0,
"features": 0,
"ownership": 96,
"area": {
"sq_meters": 26857986,
"acres": 6636.7529,
"sq_miles": 10.3699
}
},
{
"date": "2023-8-29",
"requests": 2,
"results": 0,
"tiles": 0,
"buildings": 0,
"addresses": 0,
"typeahead": 0,
"a_typeahead": 0,
"features": 0,
"ownership": 0,
"area": {
"sq_meters": 0,
"acres": 0,
"sq_miles": 0
}
},
{
"date": "2023-8-28",
"requests": 3,
"results": 2,
"tiles": 0,
"buildings": 4,
"addresses": 2,
"typeahead": 0,
"a_typeahead": 0,
"features": 0,
"ownership": 0,
"area": {
"sq_meters": 0,
"acres": 0,
"sq_miles": 0
}
}
],
"current": true,
"paid": false,
"trial": false
}
]
}
}
When to use it
Incorporate this endpoint into your workflow to check remaining parcel record balance before running large queries, set up automated alerts when usage approaches your plan limit, or display real-time consumption data in your application's dashboard.
Detailed Usage
GET /usage/detailed
Returns a granular breakdown of your API usage by endpoint, date, and query type for the current billing period. Useful for auditing consumption patterns, identifying which workflows are driving the most usage, and optimizing query strategies to reduce parcel record consumption.
Example request
GET https://app.regrid.com/api/v2/usage/detailed?begin_date=2026/01/01&end_date=2026/05/01&token=<token>
Example response
{
"usage": {
"cycle_dates": {
"begin": 1778946048,
"end": 1781624448
},
"cycle_usage": [
{
"country": "US",
"service": "api",
"requests": 6,
"parcels": 10,
"buildings": 6,
"zoning": 5,
"addresses": 134,
"ownership": 9,
"area": 41952,
"token": "Automatically Provisioned"
}
],
"date_range": {
"begin_ts": 1767268800,
"begin": "2026-01-01",
"end": "2026-05-01",
"total": [
{
"service": "api",
"country": "CA",
"requests": 2,
"parcels": 2,
"buildings": 0,
"zoning": 0,
"addresses": 0,
"ownership": 0,
"area": 0,
"token": "Automatically Provisioned"
},
{
"service": "api",
"country": "US",
"requests": 24,
"parcels": 258,
"buildings": 327,
"zoning": 150,
"addresses": 196,
"ownership": 236,
"area": 31056,
"token": "Automatically Provisioned"
},
{
"service": "featureservice",
"country": "US",
"requests": 0,
"parcels": 100,
"buildings": 0,
"zoning": 0,
"addresses": 0,
"ownership": 0,
"area": 0,
"token": "Automatically Provisioned"
}
]
}
}
}Report an Issue
POST /report
Submits a data quality report for a specific parcel, flagging incorrect attributes, geometry errors, missing data, or other discrepancies so Regrid's data team can review and correct the record. This is the recommended way to report parcel-level issues discovered during your use of the API.
Example request
POST https://app.regrid.com/api/v2/report?token=<token>
Request body parameters
| Parameter | Required | Description |
|---|---|---|
ll_uuid | Yes | The Regrid UUID of the parcel being reported |
comment | No | A description of the data issue observed |
path | No | The Regrid path of the parcel, e.g. /us/mi/wayne/detroit/364491 |
details | No | A hash with details on specific fields. This hash only accepts standard column names as keys. |
Example request body
{
"token": "<token>",
"ll_uuid": "16bc4f67-009a-496c-bd0a-9e9d55f5228b",
"message": "The parcel boundary appears to overlap an adjacent parcel. The geometry seems to be shifted slightly north from its correct position."
}
Example response
{
"message": "Report received",
"id": 2238
}When to use it
Use this endpoint when you identify a parcel with an incorrect owner name, wrong address, misaligned geometry, stale data, or any other discrepancy compared to the county source. Reports submitted through this endpoint are reviewed by Regrid's data team and may result in corrections in a future data refresh.
Updated 3 months ago