OpenAPI specification for API v3

ROIC API v3 publishes a machine-readable OpenAPI 3.0.3 spec that describes every endpoint, parameter, response schema, and authentication method. Read it in the browser to explore the API by hand. Download it as JSON to generate a client, produce types, or give it to an agent.

The spec itself is public. You need an API key only to call the endpoints it describes.

Read the spec in your browser

Open the interactive reference at api.roic.ai/v3.0.0/openapi. The page groups the operations by tag. Each operation shows its path parameters, query parameters, response schema, and an example request in several languages.

Download the spec as JSON

Add .json to the same URL to get the raw spec.

https://api.roic.ai/v3.0.0/openapi.json

The interactive page loads this file, so both URLs describe the same API.

curl -s https://api.roic.ai/v3.0.0/openapi.json -o roic-v3-openapi.json

The response is application/json, and the request needs no Authorization header.

What the spec contains

The spec reports openapi: 3.0.3 and info.version: 3.0.0. Every v3 operation is a GET, because the API is read-only.

The spec tags operations as Reference Data, Market Data, Fundamentals, Forex, Content, Calendar, or Bulk Downloads. Request and response shapes live under components.schemas, and every operation references them instead of repeating them.

components.securitySchemes declares the two authentication methods, and every operation accepts either.

Send exactly one method per request. Authentication covers when to use which.

Prefix paths with the API host

The spec has no servers block, and the path keys already include the version prefix. The exchanges endpoint, for example, appears as /v3.0.0/exchanges.

Set https://api.roic.ai as the base URL in your client or generator. Your client then appends each path from the spec unchanged.

https://api.roic.ai

Generate a client

Point any OpenAPI generator at the JSON URL. To generate TypeScript types, run openapi-typescript.

npx openapi-typescript https://api.roic.ai/v3.0.0/openapi.json -o roic-v3.d.ts

To generate a full client, run openapi-generator-cli and pick a language with -g.

npx @openapitools/openapi-generator-cli generate \
  -i https://api.roic.ai/v3.0.0/openapi.json \
  -g python \
  -o ./roic-v3-client

The generated client has no default host. Set https://api.roic.ai on it before the first call.

Give the spec to an agent

An agent that can fetch a URL reads the JSON spec and calls the endpoints it describes. The spec is public, so the agent needs your API key only for those calls.

The ROIC MCP server exposes the same endpoints as callable tools, so the agent never parses the spec.

Next steps

The spec lists the operations. These pages explain how to call them.