Apartment Fax Python SDK

The official Python client for Apartment Fax's public API endpoints. Use it to normalize NYC addresses, read public apartment previews, and check service health.

• Product: apartmentfaxnyc.com
• OpenAPI: api.apartmentfaxnyc.com/openapi.json
• Source: Potarix/apartment-fax

Install

python -m pip install apartment-fax-sdk

Python 3.10 or newer is required. The SDK has no third-party runtime dependencies.

Use

from apartment_fax_sdk import ApartmentFaxClient

apartment_fax = ApartmentFaxClient()

address = apartment_fax.resolve_address("117 West 13 Street", unit="45")
print(address["borough"], address["bbl"])

health = apartment_fax.get_health()
print(health["ok"], health["version"])

Public previews use the stable flat slug published by Apartment Fax:

preview = apartment_fax.get_preview("213-e-10th-st-apt-4r")
print(preview["address"], preview["violationCount"])

Scope

This SDK exposes Apartment Fax's public, read-only integration surface. It does not expose private report compilation, customer orders, Stripe webhooks, or capability tokens.

API failures raise ApartmentFaxApiError, which includes the HTTP status and parsed response body.