Docs

SDKs

SDKs

Hand-written Python and TypeScript clients for the ITMatrixHQ API, with readable methods, domain models, response metadata and both public wire formats.

Source on GitHub · Python on PyPI · TypeScript on npm.

LanguagePackageInstallWhat it covers
Pythonitmatrixpip install itmatrixSync and async REST, JSON and protobuf, async streams
TypeScript@itmatrixhq/corenpm install @itmatrixhq/coreREST, JSON and protobuf, streams

What both SDKs give you

  • Named methods for the common reads — get_gex / getGex, get_option_chain / getOptionChain, get_bars / getBars, list_expirations, list_symbols, lookup_symbol — and grouped resources (client.flow, client.offexchange, client.journal, client.watchlists, …) for the rest of the public API. Every reference page offers the SDK call, under the SDK switch on its Python and TypeScript examples, when one maps to the operation.
  • Stable domain models for GEX, chains and bars, the same whether the wire was JSON or protobuf.
  • Nothing lost from the response. Every result keeps data, meta, the HTTP status, the request id and the ETag. Unknown metadata is preserved.
  • Honest values. Missing measurements stay missing, timestamps are epoch milliseconds, strikes keep their exact integer thousandths. See Units.
  • Safe retries. Only GET requests are retried, only on 429/502/503/504, with bounded waits. Writes are never replayed.
  • One shared stream that owns tickets, subscriptions, pings and reconnection. See Streaming.
  • A request escape hatch — request("/v2/…") — for an operation without a named method. It accepts only /v2/ paths.

Installing an SDK does not grant access to anything: what a key can read is decided by the server. See Entitlements.

For coding agents

The agent skill teaches an agent to use these SDKs well: the smallest method for the job, keeping metadata, following cursors, and handling streams.