Official developer resources for apartmentfaxnyc.com

Apartment Fax developer resources

This is the authoritative discovery point for the ApartmentFaxNYC product, the Apartment Fax HTTP interface, and its machine-readable resources. Apartment Fax offers one public, read-only MCP integration; it is not a general-purpose third-party developer platform.

Available resources

• Apartment Fax CLI — official command-line tool for the public API.
• Apartment Fax TypeScript SDK — official npm client for the public API.
• Apartment Fax Python SDK — official PyPI client for the public API.
• Apartment Fax API sandbox — make a free public API call without an account or API key.
• Apartment Fax OpenAPI specification — live OpenAPI 3.1 description.
• Apartment Fax API reference — interactive Swagger documentation.
• Apartment Fax API versioning and deprecation policy — compatibility guarantees, notice period, and lifecycle headers.
• Apartment Fax agent authentication guide — how an agent registers, uses, and revokes its own API credential.
• Apartment Fax MCP server — read-only NYC public-record previews for ChatGPT and Codex.
• Apartment Fax llms.txt — concise, agent-readable resource index.
• Apartment Fax AI Catalog — advertised AI-facing artifacts.

Integration status

Command-line tool

apartment-fax-cli prints JSON for address normalization, public previews, and service health checks.

TypeScript SDK

apartment-fax-sdk supports server-side address normalization, public preview retrieval, and service health checks.

Python SDK

apartment-fax-sdk supports the same public API operations for Python applications.

Public developer API

The read-only /v1 routes are free with no account, API key, credit card, or sales contact. Start in the self-serve API sandbox.

Authentication

The free read-only endpoints require no authentication. An agent that needs to buy and read a full report can register its own bearer key; Apartment Fax does not run an OAuth grant.

Webhooks

No outbound developer webhooks are offered. The documented Stripe webhook is a private inbound payment endpoint.

MCP server

https://api.apartmentfaxnyc.com/mcp publishes one read-only NYC address lookup. It has no checkout, order, email, or paid-report capability.

Payments

An agent key starts with a zero balance and cannot buy a report until credits are purchased for its account. The web application also offers user-initiated checkout.

API versioning and deprecation

Supported public routes use a major version in the URL, currently /v1. Backward-compatible additions stay in v1; breaking changes use a new /vN prefix.

Before Apartment Fax retires a version, it will publish at least 180 days of notice under the API versioning and deprecation policy, in llms.txt, and in the OpenAPI description. Deprecated version responses will include Deprecation and Sunset headers. No v1 retirement is scheduled.

Rate limits

REST clients receive RateLimit-Policy and RateLimit on every response. Compatibility fields RateLimit-Limit, RateLimit-Remaining, and RateLimit-Reset carry the same fixed-window quota. A 429 response also includes Retry-After; wait that many seconds before retrying.

Inspect the API description

npx apartment-fax-cli --help
npm install apartment-fax-sdk
python -m pip install apartment-fax-sdk
curl https://apartmentfaxnyc.com/v1/health
curl https://apartmentfaxnyc.com/openapi.json

The specification describes the current first-party application contract. It does not grant access to customer reports or make private endpoints supported integrations.