GET /v2/rest-protocol.proto

Download the REST protobuf schema

stream_getRestProtocolProto

The .proto file for the protobuf response bodies served with Accept: application/x-protobuf. Plain text, no authentication required.

Details

Operations that offer protobuf say so in their description, for example GET /v2/gex/{symbol}/grid.

Response

Prices are dollars, timestamps epoch milliseconds, strikes integer thousandths of a dollar; null means unknown. Units →

200text/plain

The public protobuf schema for the negotiated REST bodies (bars / replay / gex grid / chain), served under Accept: application/x-protobuf.

Request

curl -sS "https://api.itmatrixhq.com/v2/rest-protocol.proto" \
  -H "Authorization: Bearer $ITM_API_KEY" \
  -H "Accept: text/plain"

import os
import httpx

response = httpx.get(
    "https://api.itmatrixhq.com/v2/rest-protocol.proto",
    headers={"Authorization": f"Bearer {os.environ['ITM_API_KEY']}"},
    timeout=30,
)
print(response.status_code, response.text)

import os
import itmatrix as itm

with itm.ITMClient(api_key=os.environ["ITM_API_KEY"]) as client:
    result = client.protocols.rest_schema()
    print(result.status, result.data)

const url = new URL("https://api.itmatrixhq.com/v2/rest-protocol.proto");

const response = await fetch(url, {
  headers: { Authorization: `Bearer ${process.env.ITM_API_KEY}` },
});
console.log(response.status, await response.text());

import { ITMClient } from "@itmatrixhq/core";

const client = new ITMClient({ apiKey: process.env.ITM_API_KEY });
const result = await client.protocols.restSchema();
console.log(result.status, result.data);