Integrate ReadyPermit's property intelligence directly into your applications with our powerful REST API
All API requests require authentication using your API key in the Authorization header:
API access is available for Portfolio plan subscribers. Generate your API key from your account dashboard:
Upgrade to Portfolio PlanRate limits are tracked per API key. If you exceed your limit, you'll receive a 429 status code. Contact landon@readypermit.ai or carson@readypermit.ai for enterprise volume pricing.
// Install the SDK
npm install @readypermit/sdk
// Initialize the client
const ReadyPermit = require('@readypermit/sdk');
const client = new ReadyPermit({ apiKey: 'your_api_key_here' });
// Generate a property report
const report = await client.reports.create({
address: '123 Main St, Los Angeles, CA 90210'
});
console.log(report.buildabilityScore);
console.log(report.zoning);/v1/reportsGenerate a comprehensive property report
{
"address": "123 Main St, Los Angeles, CA 90210",
"include": [
"zoning",
"environmental",
"market"
]
}{
"id": "rpt_1234567890",
"address": "123 Main St, Los Angeles, CA 90210",
"buildabilityScore": 78,
"zoning": {
"code": "R-3",
"description": "Multi-Family Residential",
"permittedUses": [
"Residential",
"Multi-family dwelling"
]
},
"status": "completed"
}/v1/reports/:idRetrieve an existing report
{
"id": "rpt_1234567890",
"address": "123 Main St, Los Angeles, CA 90210",
"buildabilityScore": 78,
"status": "completed",
"createdAt": "2025-01-15T10:30:00Z"
}/v1/geocodeGeocode an address to coordinates
{
"address": "123 Main St, Los Angeles, CA 90210"
}{
"latitude": 34.0522,
"longitude": -118.2437,
"formattedAddress": "123 Main St, Los Angeles, CA 90210"
}| Code | Status | Description |
|---|---|---|
| 200 | OK | Request succeeded |
| 400 | Bad Request | Invalid request parameters |
| 401 | Unauthorized | Invalid or missing API key |
| 429 | Too Many Requests | Rate limit exceeded |
| 500 | Internal Server Error | Server error, please try again |
Get API access with a Portfolio plan subscription and start integrating property intelligence today