{"openapi":"3.1.0","info":{"title":"OrbioIndex API","version":"1.0.0","description":"Indexed, real-time data on the Orbio CREDIT protocol (Robinhood Chain, chain 4663)."},"servers":[{"url":"https://www.orbioindex.dev"}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"OrbioIndex API key (oidx_...)"}}},"security":[{"bearer":[]}],"paths":{"/api/v1/overview":{"get":{"operationId":"get_overview","summary":"Market overview","description":"Snapshot of the whole Orbio CREDIT market: best ask and discount, order book depth, 24h and all-time volume, card purchases, activations (CREDIT burned into AI balance), CREDIT supply and holders, ORBIO staking totals and estimated APR, ORBIO and NVDA prices, and what $100 buys through buyAndActivate.","parameters":[],"responses":{"200":{"description":"OK — `{ data: ... }`"},"401":{"description":"Missing or invalid API key"},"429":{"description":"Rate limited (see X-RateLimit-* headers)"}}}},"/api/v1/orderbook":{"get":{"operationId":"get_order_book","summary":"Order book","description":"Live CREDIT order book on the Orbio Exchange, read from the contract: every price level (price in USDG per CREDIT, discount vs $1 of inference, CREDIT available, cumulative depth), open orders by source (sellers, staking auto-list, protocol fee recycling), the 40 cheapest open orders, and an integrity check comparing the index with the chain.","parameters":[],"responses":{"200":{"description":"OK — `{ data: ... }`"},"401":{"description":"Missing or invalid API key"},"429":{"description":"Rate limited (see X-RateLimit-* headers)"}}}},"/api/v1/trades":{"get":{"operationId":"get_recent_trades","summary":"Recent trades","description":"Most recent CREDIT purchases: on-chain buys, buyAndActivate (buy and burn into AI balance in one call) and card purchases settled on chain from orbio.so. Amounts in CREDIT, USD paid and average price.","parameters":[{"name":"limit","in":"query","required":false,"description":"Rows to return (1-200).","schema":{"default":25,"type":"integer","minimum":1,"maximum":200}}],"responses":{"200":{"description":"OK — `{ data: ... }`"},"401":{"description":"Missing or invalid API key"},"429":{"description":"Rate limited (see X-RateLimit-* headers)"}}}},"/api/v1/price-history":{"get":{"operationId":"get_price_history","summary":"Price history","description":"CREDIT price history built from every order book fill: volume-weighted average price (USDG per CREDIT), low/high and volume per bucket.","parameters":[{"name":"interval","in":"query","required":false,"description":"Bucket size.","schema":{"default":"1h","type":"string","enum":["1h","4h","1d"]}},{"name":"days","in":"query","required":false,"description":"How many days back (1-90).","schema":{"default":7,"type":"integer","minimum":1,"maximum":90}}],"responses":{"200":{"description":"OK — `{ data: ... }`"},"401":{"description":"Missing or invalid API key"},"429":{"description":"Rate limited (see X-RateLimit-* headers)"}}}},"/api/v1/staking":{"get":{"operationId":"get_staking","summary":"Staking","description":"ORBIO staking: total staked and share of supply, number of stakers, CREDIT minted to stakers in the last 24h, USD funding of the hourly harvests, estimated APR (at $1 face value and at the order book price), and the last 48 hourly harvests.","parameters":[],"responses":{"200":{"description":"OK — `{ data: ... }`"},"401":{"description":"Missing or invalid API key"},"429":{"description":"Rate limited (see X-RateLimit-* headers)"}}}},"/api/v1/stakers":{"get":{"operationId":"get_top_stakers","summary":"Top stakers","description":"Largest ORBIO staking positions with share of total stake, CREDIT earned, claimed and auto-listed, and auto-list price.","parameters":[{"name":"limit","in":"query","required":false,"description":"Rows to return (1-500).","schema":{"default":25,"type":"integer","minimum":1,"maximum":500}}],"responses":{"200":{"description":"OK — `{ data: ... }`"},"401":{"description":"Missing or invalid API key"},"429":{"description":"Rate limited (see X-RateLimit-* headers)"}}}},"/api/v1/holders":{"get":{"operationId":"get_top_holders","summary":"Top CREDIT holders","description":"Largest CREDIT balances (protocol contracts listed separately), with share of total supply.","parameters":[{"name":"limit","in":"query","required":false,"description":"Rows to return (1-500).","schema":{"default":25,"type":"integer","minimum":1,"maximum":500}}],"responses":{"200":{"description":"OK — `{ data: ... }`"},"401":{"description":"Missing or invalid API key"},"429":{"description":"Rate limited (see X-RateLimit-* headers)"}}}},"/api/v1/sellers":{"get":{"operationId":"get_top_sellers","summary":"Top sellers","description":"Wallets that sold the most CREDIT on the order book, with USDG proceeds.","parameters":[{"name":"limit","in":"query","required":false,"description":"Rows to return (1-200).","schema":{"default":20,"type":"integer","minimum":1,"maximum":200}}],"responses":{"200":{"description":"OK — `{ data: ... }`"},"401":{"description":"Missing or invalid API key"},"429":{"description":"Rate limited (see X-RateLimit-* headers)"}}}},"/api/v1/activations":{"get":{"operationId":"get_activations","summary":"Activations","description":"CREDIT activations (tokens burned into Orbio AI balance — the real demand for inference): daily totals split by wallet activations, buyAndActivate and card purchases, plus the top activating wallets.","parameters":[{"name":"days","in":"query","required":false,"description":"Days of daily history.","schema":{"default":30,"type":"integer","minimum":1,"maximum":180}}],"responses":{"200":{"description":"OK — `{ data: ... }`"},"401":{"description":"Missing or invalid API key"},"429":{"description":"Rate limited (see X-RateLimit-* headers)"}}}},"/api/v1/activity":{"get":{"operationId":"get_activity","summary":"Activity feed","description":"Chronological feed of Orbio on-chain activity. Filter by kinds (comma separated): buy, buy_activate, card_buy, activation, list, autolist, cancel, claim_proceeds, claim_proceeds_orbio, stake, unstake, claim_rewards, harvest, transfer, fees_recycled, orbio_buy, orbio_sell, orbio_transfer. orbio_* rows are ORBIO whale moves (buys/sells through Uniswap v4 and large transfers).","parameters":[{"name":"kinds","in":"query","required":false,"description":"Comma-separated activity kinds to include.","schema":{"type":"string"}},{"name":"minUsd","in":"query","required":false,"description":"Only rows worth at least this many USD.","schema":{"type":"number","minimum":0}},{"name":"address","in":"query","required":false,"description":"Wallet or contract address on Robinhood Chain.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}},{"name":"before","in":"query","required":false,"description":"Unix timestamp; return rows older than this (pagination).","schema":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},{"name":"limit","in":"query","required":false,"description":"Rows to return (1-200).","schema":{"default":50,"type":"integer","minimum":1,"maximum":200}}],"responses":{"200":{"description":"OK — `{ data: ... }`"},"401":{"description":"Missing or invalid API key"},"429":{"description":"Rate limited (see X-RateLimit-* headers)"}}}},"/api/v1/wallets/{address}":{"get":{"operationId":"get_wallet","summary":"Wallet","description":"Everything about one wallet in the Orbio ecosystem: live CREDIT, ORBIO, USDG balances, staked ORBIO and rank, CREDIT earned from staking, open sell orders, CREDIT bought and sold, activations and recent activity.","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet or contract address on Robinhood Chain.","schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"}}],"responses":{"200":{"description":"OK — `{ data: ... }`"},"401":{"description":"Missing or invalid API key"},"429":{"description":"Rate limited (see X-RateLimit-* headers)"}}}},"/api/v1/quote":{"get":{"operationId":"quote_buy_credit","summary":"Live buy quote","description":"Asks the Orbio Exchange contract right now what a USDG budget buys: CREDIT out, fee, fills and average price for a plain buy, and for buyAndActivate the AI balance credited and the effective cost per $1 of inference. Read-only, nothing is executed.","parameters":[{"name":"usdg","in":"query","required":false,"description":"USDG budget.","schema":{"default":100,"type":"number","exclusiveMinimum":0,"maximum":1000000}}],"responses":{"200":{"description":"OK — `{ data: ... }`"},"401":{"description":"Missing or invalid API key"},"429":{"description":"Rate limited (see X-RateLimit-* headers)"}}}},"/api/v1/protocol-events":{"get":{"operationId":"get_protocol_changes","summary":"Protocol changes","description":"Admin and treasury events on the Orbio contracts: upgrades, role changes, fee changes, payout routes, fee sweeps and settlement funding.","parameters":[{"name":"limit","in":"query","required":false,"description":"Rows to return (1-200).","schema":{"default":30,"type":"integer","minimum":1,"maximum":200}}],"responses":{"200":{"description":"OK — `{ data: ... }`"},"401":{"description":"Missing or invalid API key"},"429":{"description":"Rate limited (see X-RateLimit-* headers)"}}}},"/api/v1/status":{"get":{"operationId":"get_index_status","summary":"Index status","description":"How fresh the OrbioIndex data is: last indexed block, seconds since last sync, latest chain snapshot and row counts.","parameters":[],"responses":{"200":{"description":"OK — `{ data: ... }`"},"401":{"description":"Missing or invalid API key"},"429":{"description":"Rate limited (see X-RateLimit-* headers)"}}}},"/api/v1/ask":{"post":{"operationId":"ask","summary":"Ask in plain language","description":"Answers a question about the Orbio ecosystem using the tools above; inference runs on Orbio's gateway.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["question"],"properties":{"question":{"type":"string","maxLength":2000},"history":{"type":"array","items":{"type":"object","properties":{"role":{"enum":["user","assistant"]},"content":{"type":"string"}}}}}}}}},"responses":{"200":{"description":"OK — `{ data: { answer, toolsUsed, model, usage } }`"}}}}}}