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.
Metadata
Release files for apartment-fax-sdk 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| apartment_fax_sdk-0.1.0.tar.gz | 4.3 kB | Without provenance | Details for apartment_fax_sdk-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| apartment_fax_sdk-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for apartment_fax_sdk-0.1.0-py3-none-any.whl |
Total release size: 7.9 kB
Release files / apartment_fax_sdk-0.1.0.tar.gz
| Download URL | apartment_fax_sdk-0.1.0.tar.gz |
|---|---|
| Size | 4.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1dbd75be8f4e8e4b89dad15cd87614140f15e7fc6b393aec37635fb27a20a7be
|
|
BLAKE2b-256 checksum How to use checksums |
ca524f40aa3f43eeca29bd0277b9c295a27cb5f7b499561d5d400f08385b0352
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.4
|
Release files / apartment_fax_sdk-0.1.0-py3-none-any.whl
| Download URL | apartment_fax_sdk-0.1.0-py3-none-any.whl |
|---|---|
| Size | 3.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a64230ed315b9d35b5e175ee939a793979053063a568347c3c6e955e303d105d
|
|
BLAKE2b-256 checksum How to use checksums |
83622b55bef893d25b0f9ca321b5345d92cfe86e79b9e3837ad18e910fc36e8e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.4
|
Security for apartment-fax-sdk 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.