Docs · Basics

Authentication

The sample endpoint and the free MCP tools need no key; the Feed API takes the key issued with a Display Feed licence as a Bearer token; the Data API uses an Apify token.

SurfaceKeyHow to send it
Sample endpointnoneNo header.
MCP server, free toolsnoneNo header.
Feed API and MCP feed toolsHousingFeed keyAuthorization: Bearer <key>
Data APIApify token?token=<APIFY_TOKEN> or Authorization: Bearer <APIFY_TOKEN>

HousingFeed keys

A key is issued with a Display Feed licence, after the order form, and reads only that customer's feed. We store a hash of the key, never the key itself, so a lost key is replaced rather than recovered. Send it only over HTTPS and keep it out of browser code.

A missing or malformed header answers 401 unauthorized. See Errors and rate limits.

Try it with the demo key

This public key reads a demo feed: 200 live listings, 40 in each of San Francisco, Austin, New York, Miami and Chicago, refreshed every week like a customer feed, with the same routes, paging and change sets. It is limited to 50 requests an hour and 100 a day, shared by everyone who uses it.

curl https://housingfeed.com/api/v1/feed/status \
  -H "Authorization: Bearer hfk_OW8a2HDxz8mMYaa_s3IcLUb1-pqf2iyiBgxBVdXXfZ0"

The same key works with the MCP server's feed tools. Your own key, issued with a Display Feed licence, reads your licensed market instead.

Want the full file for your market?

Tell us your cities and what you are building. You get a sample in the production format and the listing count for your markets, usually within one business day.

Request a sample