API Overview

The FYOS API provides programmatic access to funding opportunity data and analytics.

Access Tiers

Base URL

https://api.fyos.io/v1

Response Format

All responses are JSON:

{
  "data": { ... },
  "meta": {
    "timestamp": "2026-03-15T12:00:00Z",
    "request_id": "req_abc123"
  }
}

Error Responses

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Rate limit exceeded",
    "retry_after": 60
  }
}

Error Codes

Versioning

The API uses URL versioning (/v1/). Breaking changes require a new version.

Pagination

List endpoints support pagination:

GET /v1/opportunities?limit=50&offset=0

Filtering

Many endpoints support filtering:

GET /v1/opportunities?exchange=binance&min_apr=50

SDKs

Official SDKs (coming soon):

• Python
• TypeScript/JavaScript

Rate Limiting

Rate limits are per API key. Headers indicate current usage:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1710504000

Quick Start

1. Get your API key from Account → API Keys
2. Include in requests: Authorization: Bearer <your-api-key>
3. Start with GET /v1/opportunities to list opportunities

See Authentication and Endpoints for details.