Skip to content
Open Oracle

Documentation

Docs. Everything you need to understand and run the Open Oracle tools.

Docs / Overview / Introduction

Overview

Introduction

What Open Oracle is, why it exists, and the fastest way to try it.

Open Oracle is a set of open-source tools for tokenized stocks: tokens that track a listed share but trade around the clock, while the share itself only trades during exchange hours. The tools give you the real reference price, the market hours, and a way to act on the gap between the two.

Why it exists

When the exchange closes, a tokenized stock keeps trading but its reference price stops moving. Pools then quote against a frozen number, and whoever reacts first to after-hours news takes value from liquidity providers. During the session the opposite problem appears: a pool can drift from the real price faster than arbitrage corrects it.

Open Oracle makes that gap visible and enforceable. Off-chain tools measure it and warn you; an on-chain hook prices it into every swap, or stops the swap when the gap is too large.

Principles

  1. 1.Open source, MIT licensed, every number reproducible from public data.
  2. 2.One rulebook: the SDK and the hook compute fees the same way.
  3. 3.Market hours are first-class: every price is read together with whether its market is open.
  4. 4.Small pieces you can adopt one at a time.

The pieces

RepositoryWhat it does
oracle-sdkTypeScript library: Pyth prices, market hours, pool prices, premium, fee quotes
oracle-cliThe SDK in your terminal: oracle price, oracle hours, oracle fee
stocks-monitorService that tracks tokens against their real price over HTTP and SSE
oracle-alertsTelegram bot that alerts you when a token drifts
stockguard-hookUniswap v4 hook that checks every swap in a tokenized-stock pool
equity-feedsEvery Pyth equity feed id and schedule as JSON, refreshed daily

Try it in one minute

No key needed. Install the CLI and check whether the US market is open:

npm install -g github:openoracle-evm/oracle-cli
terminal
oracle hours --days 3oracle feed NVDAoracle fee --pool 184.2 --oracle 182.4

Or open the StockGuard simulator on this site and watch the hook react to a closed market or a price shock.

Pyth API key

Feed search and market hours are public. Live prices come from Pyth Hermes, which requires an API key since 2026-08-26 (free trial at the Pyth Terminal). Set it as PYTH_API_KEY wherever a tool asks for it.