Fractio API - Full Documentation

Introduction

Welcome to the Fractio API documentation. This API allows you to access and manage property data, investments, and analytics for fractional real estate investments.

Base URL: https://api.fractio.com/v1

Authentication

The Fractio API uses API keys for authentication. Include your API key in the header of each request:

Authorization: Bearer YOUR_API_KEY

To obtain an API key, sign up on the Developer Portal.

Rate Limiting

The API is rate limited to ensure fair usage. Limits vary by tier:

Basic Tier: 1000 requests per day
Standard Tier: 10,000 requests per day
Premium Tier: 100,000 requests per day

Rate limit information is included in the response headers:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1623456789

Endpoints

GET /properties

Retrieves a list of properties.

Query Parameters:

Parameter	Type	Description
page	integer	Page number for pagination (default: 1)
limit	integer	Number of results per page (default: 20, max: 100)

Response:

{
  "properties": [
    {
      "id": "prop123",
      "address": "123 Main St",
      "city": "New York",
      "state": "NY",
      "value": 500000,
      "available_shares": 0.5
    },
    ...
  ],
  "total": 100,
  "page": 1,
  "limit": 20
}

GET /properties/{id}

Retrieves details of a specific property.

Path Parameters:

Parameter	Type	Description
id	string	Unique identifier of the property

Response:

{
  "id": "prop123",
  "address": "123 Main St",
  "city": "New York",
  "state": "NY",
  "value": 500000,
  "available_shares": 0.5,
  "details": {
    "bedrooms": 3,
    "bathrooms": 2,
    "sqft": 2000,
    "year_built": 1990
  },
  "financial_data": {
    "monthly_rent": 3000,
    "annual_expenses": 5000,
    "projected_appreciation": 0.03
  }
}

GET /investments

Retrieves a list of investments for the authenticated user.

Query Parameters:

Parameter	Type	Description
page	integer	Page number for pagination (default: 1)
limit	integer	Number of results per page (default: 20, max: 100)

Response:

{
  "investments": [
    {
      "id": "inv789",
      "property_id": "prop123",
      "amount": 50000,
      "share": 0.1,
      "date": "2023-01-15T00:00:00Z",
      "status": "active"
    },
    ...
  ],
  "total": 5,
  "page": 1,
  "limit": 20
}

POST /investments

Creates a new investment.

Request Body:

{
  "property_id": "prop123",
  "amount": 25000
}

Response:

{
  "id": "inv112",
  "property_id": "prop123",
  "amount": 25000,
  "share": 0.05,
  "date": "2023-06-01T00:00:00Z",
  "status": "pending"
}

Errors

The API uses standard HTTP status codes to indicate the success or failure of requests. In case of an error, the response body will contain more details:

{
  "error": {
    "code": "invalid_request",
    "message": "The property ID is invalid.",
    "details": {
      "property_id": "prop999"
    }
  }
}

Common error codes include:

400 Bad Request - Invalid parameters
401 Unauthorized - Invalid API key
403 Forbidden - Insufficient permissions
404 Not Found - Resource not found
429 Too Many Requests - Rate limit exceeded
500 Internal Server Error - Server-side error

Webhooks

Fractio API supports webhooks for real-time updates. To set up a webhook:

Go to the Developer Portal
Navigate to the Webhooks section
Add a new webhook URL
Select the events you want to subscribe to

Webhook payload example:

{
  "event": "investment.created",
  "timestamp": "2023-06-01T12:00:00Z",
  "data": {
    "investment_id": "inv112",
    "property_id": "prop123",
    "amount": 25000,
    "share": 0.05
  }
}