API Access
Integrate PropExtract into your workflow with our REST API.
Your API Key
pe-api-m8k2f9x7...1,847 / 3,000 documents this month62%
API Endpoints
POST
/api/documents/upload
Upload a property document (PDF, DOCX, or image) for AI extraction.
GET
/api/documents/:id
Retrieve extraction results and metadata for a processed document.
GET
/api/documents
List all documents with optional filters for status, type, and property.
GET
/api/properties
List tracked properties with lease status, valuations, and document counts.
GET
/api/leases
List lease entries with expiration tracking and renewal status.
POST
/api/extract
Submit a document URL or base64 payload for on-demand field extraction.
DELETE
/api/documents/:id
Delete a document and its associated extraction data.
Quick Start — Python
import requests
with open("lease.pdf", "rb") as f:
response = requests.post(
"https://api.propextract.com/v1/extract",
headers={"Authorization": "Bearer pe-api-m8k2f9..."},
files={"file": f},
data={
"document_type": "auto_detect",
"extract_comparables": True,
"output_format": "json"
}
)
data = response.json()
print(f"Property: {data['property']['address']}")
print(f"Monthly rent: ${data['financial']['monthly_rent']:,}")
print(f"Lease expires: {data['term']['end']}")Webhook Configuration