Skip to main content
POST /v1/permits/stats counts permits and groups them. It counts the permits that a Permits API search of the same area and filters would match. Use it to see trends without paging through every permit.
  • Each group returned costs one permit row: $0.012 on Free, $0.0086 on Build and $0.0072 on Growth. See Pricing.
  • A call that returns no group is free. That includes a count (limit: 0), an area with no matching permits, and a parcel address or point that selects no single parcel.
  • It needs accepted terms and licensed access with the earth.search scope, the same as a permits search. See Authentication.

Example: solar permits per month in one county

Values are illustrative. Over hosted MCP, the tool is mireye_permits_stats. Send the same body inside req:

Request

  • Any other key is rejected with 422. There is no sort and no cursor.
  • An unknown group_by or measure is rejected with the valid values.

Groups

  • With tag, a permit with two tags counts in both groups. So the tag groups can add up to more than total_permits. The note says so.
  • Groups with the same count are ordered by key.

Measures

A measure is null when no permit in the group has a value for it.

Response

  • With partial, not_collected or null coverage, every count is a lower bound. A 0 is then not proof that no permits exist.
  • Branch on coverage, not on the note text.

Count for free

Send limit: 0 to get total_groups and total_permits with no groups. It is not charged.

Price

  • One permit row for each group returned.
  • The most it can cost, limit rows, is reserved first. Set max_cost_usd at or above it.
  • A call with no group is free:
    • a count (limit: 0);
    • an area with no matching permits;
    • a parcel address or point that selects no single parcel;
    • a call that fails.
  • Send a stable Idempotency-Key to retry without a second charge. See Retries.

Errors

The same as a permits search. See Errors. A request that is not valid gets 422 permits_invalid_request with a problems list.