Skip to main content

Client libraries

We publish an OpenAPI document rather than maintaining SDKs. Here is how to generate a client from it.

Data and PropTech platformsAI-native analysts and MCP clients

There is no hand-maintained Boardwalk SDK, and that is deliberate: a client library that lags the API is worse than no library, because it looks authoritative. We publish a generated OpenAPI 3.0 document instead, and it is produced from the same registries that serve the responses.

bash
# The canonical document
curl https://api.boardwalkai.com/api/reference.json -o boardwalk.json

Generate a typed client

bash
# TypeScript types only — no runtime dependency
npx openapi-typescript boardwalk.json -o boardwalk.d.ts

# A full client, any of ~50 languages
npx @openapitools/openapi-generator-cli generate \
  -i boardwalk.json \
  -g python \
  -o ./boardwalk-client

For agents, the MCP server is the client library

If you are building on an LLM, do not generate a client — install the MCP server. It carries the tool schemas, the credit costs and the budget guidance already.

Ready to make a call?

A free Boardwalk trial includes API access and a sandbox key. Counting, filtering, the location tree and the analytics plane cost nothing, so you can evaluate the data before you spend a credit.