org.passingreads.book.getLocationCounts Documentation (EN)

main query

Get book counts grouped by H3 cell, for rendering the homepage map at varying zoom levels.

Parameters

resolution integer Optional

If provided, only return cells at this H3 resolution. If omitted, returns counts at all resolutions (parents up the hierarchy).

Output

Encodingapplication/json

locations array Required

No description available.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

resolution If provided, only return cells at this H3 resolution. If omitted, returns counts at all resolutions (parents up the hierarchy).

View raw schema

{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "locations"
      ],
      "properties": {
        "locations": {
          "type": "array",
          "items": {
            "ref": "org.passingreads.defs#locationEntry",
            "type": "ref"
          }
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "properties": {
      "resolution": {
        "type": "integer",
        "maximum": 15,
        "minimum": 0,
        "description": "If provided, only return cells at this H3 resolution. If omitted, returns counts at all resolutions (parents up the hierarchy)."
      }
    }
  },
  "description": "Get book counts grouped by H3 cell, for rendering the homepage map at varying zoom levels."
}