Build on Aryna's API
Integrate pricing data, communities, and floor plans directly into your property management systems with our developer-friendly REST API.
Everything you need to integrate
Aryna's API provides programmatic access to all PriceWatch data with enterprise-grade reliability, security, and performance.
OpenAPI 3.0 Specification
Complete API documentation with schema definitions, examples, and interactive testing built-in.
Secure API Key Authentication
Scope-based permissions let you control exactly what each API key can access. Rotate keys anytime.
Rate Limiting (100 req/min)
Fair rate limits ensure reliable performance for all users. Contact us for higher limits.
SDKs & Examples
Code examples in cURL, JavaScript, Python, and more. Postman collection available for import.
GET /v1/pricewatch/communities/123
Authorization: Bearer aryna_pk_...
{
"success": true,
"data": {
"id": "123",
"name": "Oak Ridge Apartments",
"address": "123 Main St",
"comps": [
{
"name": "Pine View",
"distance": 0.8,
"pricing": {
"1BR/1BA": 1850
}
}
]
}
}Powerful endpoints for every use case
Access communities, pricing data, floor plans, and comparable properties with simple REST calls.
Communities Management
Create, read, update, and delete communities. Sync your property portfolio programmatically.
PriceWatch Portfolio
Get portfolio-wide pricing statistics and performance metrics across all properties.
PriceWatch Communities
Access detailed community data including comparables, pricing trends, and floor plans.
Pricing Data & Floor Plans
Historical pricing trends and current floor plan-level pricing for detailed analysis.
Built for real-world integrations
Property Management Systems
Sync communities bidirectionally between Aryna and your PMS. Push pricing updates to your system automatically.
POST /v1/communitiesCustom Dashboards & Reports
Build custom analytics dashboards that pull real-time pricing data, trends, and comparative analysis.
GET /v1/pricewatch/portfolioAutomated Rent Survey Workflows
Trigger surveys programmatically, fetch results, and generate custom reports in your existing workflow.
GET /v1/pricewatch/communities/{id}Data Warehousing & BI Tools
Export pricing data to your data warehouse for historical analysis, trend forecasting, and ML models.
GET /v1/pricewatch/communities/{id}/pricingGetting Started
Sign up for Aryna
Create a free account to access the API. No credit card required for the 14-day trial.
Generate an API key
Go to Settings → API Keys and create a new key with the scopes you need.
Make your first API call
Use the interactive docs to test endpoints or copy code examples in your language.
Build and deploy
Integrate Aryna into your workflows and go to production.
Example: Fetch Pricing Data
curl https://api.aryna.ai/v1/pricewatch/\
communities/123/pricing \
-H "Authorization: Bearer aryna_pk_..." \
-H "Content-Type: application/json"
# Response
{
"success": true,
"data": {
"pricing": [
{
"floor_plan_id": "fp_123",
"floor_plan_name": "1BR/1BA",
"market_rent": 1850,
"effective_date": "2024-11-20"
}
]
}
}Ready to start building?
Get your API key and start integrating PriceWatch data today.