API Endpoints

Reference for all available FYOS API endpoints.

Opportunities

List Opportunities

GET /v1/opportunities

Returns all active funding opportunities.

Query Parameters:

Parameter	Type	Description
`exchange`	string	Filter by exchange (binance, bybit, okx)
`min_apr`	number	Minimum funding APR
`max_mirage`	number	Maximum mirage ratio
`min_survivability`	number	Minimum survivability score
`sort`	string	Sort field (default: edge_value)
`order`	string	Sort order (asc, desc)
`limit`	number	Results per page (max: 100)
`offset`	number	Pagination offset

Response:

{
  "data": {
    "opportunities": [
      {
        "symbol": "BTCUSDT",
        "exchange": "binance",
        "funding_apr": 45.2,
        "survivable_apr": 32.1,
        "mirage_ratio": 0.29,
        "half_life_hours": 36,
        "survivability_score": 71,
        "edge_value_score": 68,
        "soft_capacity_usd": 2500000,
        "updated_at": "2026-03-15T12:00:00Z"
      }
    ],
    "total": 156,
    "limit": 50,
    "offset": 0
  }
}

Get Opportunity

GET /v1/opportunities/:symbol

Returns detailed data for a specific opportunity.

Path Parameters:

Parameter	Description
`symbol`	Opportunity symbol (e.g., BTCUSDT)

Query Parameters:

Parameter	Type	Description
`exchange`	string	Exchange (required if symbol exists on multiple)

Response:

{
  "data": {
    "symbol": "BTCUSDT",
    "exchange": "binance",
    "funding_apr": 45.2,
    "survivable_apr": 32.1,
    "mirage_ratio": 0.29,
    "half_life_hours": 36,
    "survivability_score": 71,
    "edge_value_score": 68,
    "soft_capacity_usd": 2500000,
    "hard_capacity_usd": 5000000,
    "open_interest_usd": 125000000,
    "reliability_score": 82,
    "funding_history": [...],
    "updated_at": "2026-03-15T12:00:00Z"
  }
}

Simulation

Run Simulation

POST /v1/simulate

Simulates expected PnL for a position.

Request Body:

{
  "symbol": "BTCUSDT",
  "exchange": "binance",
  "position_size_usd": 10000,
  "holding_hours": 24,
  "entry_fee_bps": 5,
  "exit_fee_bps": 5
}

Response:

{
  "data": {
    "summary": {
      "net_expected_pnl_usd": 8.54,
      "net_expected_return_pct": 0.0854,
      "total_fees_usd": 10.00
    },
    "breakdown": {
      "gross_funding_pnl_usd": 12.37,
      "decay_adjusted_pnl_usd": 9.28,
      "survivable_pnl_usd": 8.87,
      "capacity_adjusted_pnl_usd": 8.87,
      "capacity_penalty_factor": 1.0
    },
    "inputs_used": {
      "funding_apr": 45.2,
      "half_life_hours": 36,
      "survivability_score": 71,
      "soft_capacity_usd": 2500000
    }
  }
}

Portfolio (Desk Tier)

Create Allocation Plan

POST /v1/portfolio/plan

Creates an allocation plan for capital deployment.

Request Body:

{
  "capital_usd": 100000,
  "holding_hours": 48,
  "risk_tolerance": "moderate"
}

Response:

{
  "data": {
    "allocations": [
      {
        "symbol": "BTCUSDT",
        "exchange": "binance",
        "allocation_usd": 25000,
        "expected_pnl_usd": 21.35,
        "expected_return_pct": 0.0854
      }
    ],
    "summary": {
      "total_allocated_usd": 85000,
      "capital_efficiency": 0.85,
      "expected_portfolio_return_pct": 0.072,
      "portfolio_risk_score": 42
    }
  }
}

Webhooks (Coming Soon)

Subscribe to real-time updates for opportunities matching your criteria.

POST /v1/webhooks

Request Body:

{
  "url": "https://your-app.com/webhook",
  "events": ["opportunity.high_edge", "opportunity.mirage_change"],
  "filters": {
    "min_edge_value": 70,
    "exchanges": ["binance", "bybit"]
  }
}

Authentication FAQ