> For the complete documentation index, see [llms.txt](https://docs.chirpwireless.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.chirpwireless.io/api.md).

# API

Get programmatic access to your home's sensor data for scripts, spreadsheets, and smart-home integrations.

Chirp's **API** lets you bring your home into scripts and tools you build yourself. Pull sensor readings into a personal report or send an existing device command from an integration, using the same home workspace as your dashboards and automations.

An **API**, or application programming interface, is how software requests those operations. The [REST API](/api/public-rest-api.md) is the starting point for a script; [MCP](/api/mcp-server.md) connects an AI client that can help configure your home through conversation.

Begin with the [REST API](/api/public-rest-api.md), which uses ordinary web requests. You will need an [API key](/settings/api-keys.md), a credential for your integration, and the identifier of the home it belongs to. The key's **scopes** are the operations it is allowed to use. The [API reference](https://api.chirpwireless.io/) lists those requirements for each call.

## REST is the way in

For home scripts and integrations, the **REST API** is the practical starting point: plain HTTPS and JSON that works from any language, tool, or no-code automation. Almost anything you'd want at home — read a sensor's latest value, pull history into a spreadsheet, bridge readings into another smart-home platform — is a REST call. See [REST API](/api/public-rest-api.md).

A **gRPC API** also exists — the advanced / on-premise path. It is not the normal homeowner path: for home scripts and tools use REST, and reach for gRPC only if you specifically need it for an on-premise or typed service-to-service integration. See [gRPC API](/api/grpc-api.md).

## Bringing your own AI app

If you'd rather not write code at all, the **MCP server** connects an AI client like Claude Code or Claude Desktop directly to your home. You sign in with your usual Chirp account — no key to create — and the AI app can then list your sensors, check your alerts, or add a device for you, with exactly your own permissions. See [MCP Server](/api/mcp-server.md).

## Signing requests

Each request carries a scoped API key in the `X-API-Key` header (format `chirp_<key>`) and your home's context in `X-Organization-Id`. You create and manage keys in **Settings → API Keys**; the essentials are in [Authentication & API keys](/api/authentication-and-api-keys.md), and the full walkthrough is in [API Keys](/settings/api-keys.md).

## In this section

* [REST API](/api/public-rest-api.md) — the normal way to connect scripts and tools.
* [gRPC API](/api/grpc-api.md) — only for advanced typed-client or service integrations.
* [MCP Server](/api/mcp-server.md) — connect your own AI app to your home.
* [Authentication & API keys](/api/authentication-and-api-keys.md) — how requests are signed.
* [Examples](/api/examples.md) — a first authenticated request.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.chirpwireless.io/api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.