Skip to Content
Hey Town Hall Data docs
Documents

API reference · Documents

Retrieve a bylaw

View as Markdown
GET
/v1/bylaws/{id}

One bylaw. Billed as one records request.

Authorization

bearerAuth
headerAuthorizationBearer <token>

htd_test_ (sandbox, free, fictional towns) or htd_live_ (live, billed) key.

Path Parameters

id*string
Match^[0-9]{1,18}$

Response Body

The record.

application/json
  1. response
id*string
jurisdiction_id*string
country*string|null
region*string|null
number*string|null
title*string|null
kind*string|null
adopted_on*|

YYYY-MM-DD.

text_available*boolean
subject*|

The core subject its text regulates: zoning, building, animal_control, fire_burning, noise, trees, business_licence, fees_charges or other. Null: not yet read, or nothing says.

first_seen_at*|

ISO 8601 instant, UTC.

source_url*|

The page, document, video or platform the record was read from.

read_at*|

When it was read.

environment*string
Value in"sandbox""live"
Example Request
curl -X GET 'https://data.heytownhall.com/v1/bylaws/string'
Example Response
{  "id": "string",  "jurisdiction_id": "string",  "country": "string",  "region": "string",  "number": "string",  "title": "string",  "kind": "string",  "adopted_on": "string",  "text_available": true,  "subject": "string",  "first_seen_at": "string",  "source_url": "string",  "read_at": "string",  "environment": "sandbox"}