> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orica.markets/llms.txt
> Use this file to discover all available pages before exploring further.

# API Overview

> Introduction to the Orica Public API.

![Orica API](https://mintcdn.com/orica/YTb3GLKscfwACNYH/images/image.png?fit=max\&auto=format\&n=YTb3GLKscfwACNYH\&q=85\&s=e73cf6aae2197856e6870aea5faa9df8)

The Orica API provides programmatic access to market data, trade history, and dispute information. It combines REST endpoints for querying data with WebSocket streams for real-time updates.

***

## Base URL

All API requests are made to:

```
https://api.orica.markets
```

***

## Features

> [card] REST API
>
> Query markets, trades, disputes, and analytics with standard HTTP requests.

> [card] WebSocket
>
> Subscribe to real-time price updates and trade activity feeds.

> [card] No Authentication
>
> Public endpoints are open and require no API keys.

> [card] Rate Limited
>
> Fair usage limits prevent abuse while allowing reasonable access.

***

## Response Format

All responses are JSON. Successful responses return data directly:

```json theme={"dark"}
{
  "address": "ABC123...",
  "question": "Will ETH flip BTC?",
  "status": "open",
  ...
}
```

Error responses include a message:

```json theme={"dark"}
{
  "detail": "Market not found"
}
```

***

## HTTP Status Codes

| Code | Meaning |
| - | - |
| `200` | Success |
| `400` | Bad request (invalid parameters) |
| `404` | Resource not found |
| `429` | Rate limit exceeded |
| `500` | Server error |

***

## Pagination

List endpoints support pagination with `limit` and `offset` parameters:

```bash theme={"dark"}
curl "https://api.orica.markets/markets?limit=50&offset=100"
```

| Parameter | Type | Default | Max |
| - | - | - | - |
| `limit` | integer | 100 | 1000 |
| `offset` | integer | 0 | - |

***

## Content Types

* **Request**: `application/json` for POST/PUT bodies
* **Response**: `application/json` for all responses
* **Compression**: GZip compression for responses >1KB

***

## CORS

The API supports Cross-Origin Resource Sharing (CORS) from all origins, allowing browser-based applications to make requests directly.

***

## Quick Reference

| Resource | Endpoint | Description |
| - | - | - |
| Markets | `GET /markets` | List all markets |
| Trades | `GET /trades/market/{address}` | Get trades for a market |
| Disputes | `GET /disputes` | List all disputes |
| Health | `GET /health` | Check API status |
| WebSocket | `WS /ws/markets/{address}` | Real-time market data |
| WebSocket | `WS /ws/activity` | Real-time trade activity |

***

## Next Steps

> [card] [Authentication](https://docs.orica.markets/api-reference/authentication.md)
>
> Learn about API access and keys.

> [card] [Rate Limits](https://docs.orica.markets/api-reference/rate-limits.md)
>
> Understand usage limits.

> [card] [Markets](https://docs.orica.markets/api-reference/rest/markets.md)
>
> Query market data.

> [card] [WebSocket](https://docs.orica.markets/api-reference/websocket/market-data.md)
>
> Subscribe to real-time updates.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.