Aryna

Aryna API Documentation

Version 1.0

Dashboard

Welcome to the Aryna API

Build powerful integrations with the Aryna Compliance Portal. Our RESTful API allows you to programmatically manage users, communities, and compliance data.

Base URL

Production
https://api.aryna.ai/v1

All API requests should be made to this base URL.

Quick Start

  1. 1

    Get your API key

    Navigate to Settings → API Keys in your dashboard and create a new API key with the required scopes.

  2. 2

    Make your first request

    Use your API key in the Authorization header:

    curl https://api.aryna.ai/v1/communities \
  -H "Authorization: Bearer YOUR_API_KEY"
  3. 3

    Explore the API

    Check out our endpoint documentation and code examples to build your integration.

Documentation Formats

Choose the documentation format that works best for your workflow:

Interactive OpenAPI Docs

Explore and test API endpoints directly in your browser with Swagger UI. Includes request/response examples and schema validation.

Try it now

Postman Collection

Import pre-configured requests with examples into Postman. Perfect for testing and debugging API calls during development.

Download JSON

OpenAPI Spec (JSON)

Machine-readable API specification for automated code generation, testing, and integration with API tools.

Download JSON

API Features

Secure Authentication

API key-based authentication with granular scope permissions for secure access control.

Rate Limiting

100 requests per minute per API key with clear rate limit headers in every response.

RESTful Design

Standard HTTP methods, JSON responses, and predictable resource-oriented URLs.

Clear Error Messages

Detailed error responses with specific error codes and helpful messages for debugging.

Available Endpoints

Users API

Invite and manage users in your organization. Assign roles and control access.

POST /users/inviteGET /users/:idPATCH /users/:id

Communities API

Manage apartment communities and property portfolios. Assign managers and track properties.

GET /communitiesPOST /communitiesPATCH /communities/:id

PriceWatch API

Access comparable communities, pricing data, and rent survey insights. Build custom pricing dashboards and analytics.

GET /pricewatch/portfolioGET /pricewatch/communitiesGET /pricewatch/communities/:id
GET /communities/:id/compsGET /communities/:id/pricingGET /communities/:id/floor-plans

Requires scope: pricewatch:read

View detailed PriceWatch API docs

Need Help?

Our team is here to help you build successful integrations. Reach out if you have questions or need assistance.

Contact SupportDownload OpenAPI Spec