Metadata-Version: 2.4
Name: apartment-fax-sdk
Version: 0.1.0
Summary: Official Python SDK for the Apartment Fax public API.
Author: Apartment Fax
Project-URL: Homepage, https://apartmentfaxnyc.com
Project-URL: Documentation, https://apartmentfaxnyc.com/developers
Project-URL: Repository, https://github.com/Potarix/apartment-fax
Project-URL: API specification, https://apartmentfaxnyc.com/openapi.json
Keywords: apartment-fax,new-york-city,nyc-housing,real-estate,sdk
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.10
Description-Content-Type: text/markdown

# 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](https://apartmentfaxnyc.com)
- OpenAPI: [api.apartmentfaxnyc.com/openapi.json](https://api.apartmentfaxnyc.com/openapi.json)
- Source: [Potarix/apartment-fax](https://github.com/Potarix/apartment-fax/tree/main/packages/python-sdk)

## Install

```sh
python -m pip install apartment-fax-sdk
```

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

## Use

```python
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:

```python
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`.
