{"openapi":"3.1.0","info":{"title":"XOOMAR market data API","version":"2026-09-15","summary":"Free market data from primary sources: SEC, FINRA, CFTC, the Federal Reserve, Treasury, BLS/BEA/Census and the exchanges.","description":"JSON and CSV over plain GET. Every response carries the same envelope: data, updatedAt, source, docs, license, attribution and meta, whose sourceAttribution line credits the publisher of the data. No key needed to start: 10 requests a minute per IP without a key and 30 a minute with a free account key, with at least six months of history. Data terms: https://xoomar.com/terms. Credit XOOMAR with a link to the dataset page when you republish the data.","termsOfService":"https://xoomar.com/terms","contact":{"name":"XOOMAR","url":"https://xoomar.com/developers","email":"info@xoomar.com"},"license":{"name":"XOOMAR data terms","url":"https://xoomar.com/terms"}},"servers":[{"url":"https://xoomar.com"}],"tags":[{"name":"Companies","description":"SEC and FINRA data on US listed companies"},{"name":"Crypto","description":"Crypto derivatives and on-exchange data"},{"name":"Macro","description":"Positioning, rates, Fed, Treasury and the calendar"}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"x-api-key","description":"Free account key from /account"}}},"paths":{"/api/markets/short-interest":{"get":{"summary":"FINRA short interest","externalDocs":{"url":"https://xoomar.com/markets/api/short-interest"},"description":"Without symbol: the latest settlement, highest days to cover. With symbol: the symbol's biweekly history since December 2017, newest first, up to 200 reports. Docs: https://xoomar.com/markets/api/short-interest","operationId":"short_interest","tags":["Companies"],"parameters":[{"name":"symbol","in":"query","required":false,"description":"US ticker (class shares as BRK-B)","schema":{"type":"string"},"example":"GME"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"settlementDate":{"type":"string","format":"date","description":"FINRA settlement date (~15th and month-end)"},"symbol":{"type":"string","description":"Ticker symbol"},"shortQty":{"type":["number","null"],"description":"Total shares held short"},"avgDailyVol":{"type":["number","null"],"description":"Average daily trading volume"},"daysToCover":{"type":["string","null"],"description":"shortQty / avgDailyVol, FINRA-computed"},"changePct":{"type":["string","null"],"description":"Change in short quantity vs the prior report"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/short-volume":{"get":{"summary":"FINRA daily short sale volume","externalDocs":{"url":"https://xoomar.com/markets/api/short-interest"},"description":"Without symbol: the latest day, the 100 highest short shares of volume (sort=shares for the largest volumes). With symbol: daily history, oldest first; history starts in August 2021 and the free API returns the last six months. Docs: https://xoomar.com/markets/api/short-interest","operationId":"short_volume","tags":["Companies"],"parameters":[{"name":"symbol","in":"query","required":false,"description":"US ticker (class shares as BRK-B)","schema":{"type":"string"},"example":"GME"},{"name":"days","in":"query","required":false,"description":"Window in days (default 60, max 5000)","schema":{"type":"integer"},"example":60},{"name":"from","in":"query","required":false,"description":"First trade date (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-01-01"},{"name":"to","in":"query","required":false,"description":"Last trade date (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-01-01"},{"name":"limit","in":"query","required":false,"description":"Rows returned, newest first inside the window (default 60, max 5000)","schema":{"type":"integer"},"example":60},{"name":"sort","in":"query","required":false,"description":"Latest-day view: largest short volumes in shares","schema":{"type":"string","enum":["shares"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date","description":"Trade date"},"symbol":{"type":"string","description":"Ticker as FINRA publishes it"},"shortVolume":{"type":"number","description":"Shares sold short that day, as reported to FINRA's facilities"},"shortExemptVolume":{"type":["number","null"],"description":"Short sales marked exempt"},"totalVolume":{"type":"number","description":"Total shares reported to FINRA's facilities that day (not the consolidated tape)"},"shortRatio":{"type":["number","null"],"description":"shortVolume divided by totalVolume"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/fails-to-deliver":{"get":{"summary":"SEC fails to deliver","externalDocs":{"url":"https://xoomar.com/markets/api/short-interest"},"description":"Without symbol: the latest settlement date, 100 largest fails by dollar value. With symbol: settlement dates on file, oldest first; history starts in January 2010 and the free API returns the last six months. Docs: https://xoomar.com/markets/api/short-interest","operationId":"fails_to_deliver","tags":["Companies"],"parameters":[{"name":"symbol","in":"query","required":false,"description":"US ticker (class shares as BRK-B)","schema":{"type":"string"},"example":"GME"},{"name":"from","in":"query","required":false,"description":"First settlement date (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-01-01"},{"name":"to","in":"query","required":false,"description":"Last settlement date (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-01-01"},{"name":"limit","in":"query","required":false,"description":"Rows returned, newest first inside the window (default 400, max 5000)","schema":{"type":"integer"},"example":400}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"settlementDate":{"type":"string","format":"date","description":"Settlement date"},"cusip":{"type":"string","description":"CUSIP of the security"},"symbol":{"type":["string","null"],"description":"Ticker"},"quantity":{"type":"number","description":"Shares failed to deliver, as the SEC publishes them"},"description":{"type":["string","null"],"description":"Security description as the SEC publishes it"},"price":{"type":["number","null"],"description":"Closing price the SEC reports with the row, USD"},"valueUsd":{"type":["number","null"],"description":"quantity times price, USD"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/threshold-list":{"get":{"summary":"Regulation SHO threshold securities lists","externalDocs":{"url":"https://xoomar.com/markets/api/short-interest"},"description":"Names with fails to deliver of 10,000+ shares and 0.5% of shares outstanding for five straight settlement days, per listing market per day. Docs: https://xoomar.com/markets/api/short-interest","operationId":"threshold_list","tags":["Companies"],"parameters":[{"name":"date","in":"query","required":false,"description":"One list date (default the newest) (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-01-01"},{"name":"symbol","in":"query","required":false,"description":"US ticker (class shares as BRK-B)","schema":{"type":"string"},"example":"GME"},{"name":"market","in":"query","required":false,"description":"Listing market","schema":{"type":"string","enum":["nasdaq","cboe"]}},{"name":"limit","in":"query","required":false,"description":"Rows returned, newest first inside the window (default 1000, max 5000)","schema":{"type":"integer"},"example":1000}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date","description":"List date"},"market":{"type":"string","description":"nasdaq or cboe"},"symbol":{"type":"string","description":"Ticker (class shares as BRK-B)"},"securityName":{"type":["string","null"],"description":"Security name as listed"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/insiders":{"get":{"summary":"SEC Form 4 insider trades, latest across companies","externalDocs":{"url":"https://xoomar.com/markets/api/insiders"},"description":"Open-market purchases (type=buys) or sales (type=sells) in the window, newest first, 100 rows. A row whose filing states no price has pricePerShare and valueUsd null and priceNote \"price not stated in the filing\"; a price given as a range of the filing is its midpoint, marked approximate in priceNote. Docs: https://xoomar.com/markets/api/insiders","operationId":"insiders","tags":["Companies"],"parameters":[{"name":"type","in":"query","required":false,"description":"Purchases or sales (default buys; the Form 4 codes P and S work too)","schema":{"type":"string","enum":["buys","sells"]}},{"name":"window","in":"query","required":false,"description":"Lookback (default 30d)","schema":{"type":"string","enum":["7d","30d","90d"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"ticker":{"type":["string","null"],"description":"Trading symbol of the issuer, when reported in the filing"},"insiderName":{"type":"string","description":"Reporting officer, director, or 10% owner"},"insiderTitle":{"type":["string","null"],"description":"Role at the company (CEO, CFO, Director...)"},"txDate":{"type":"string","format":"date","description":"Transaction date from the filing, YYYY-MM-DD"},"shares":{"type":["string","null"],"description":"Shares bought or sold"},"pricePerShare":{"type":["string","null"],"description":"Reported price per share in USD"},"valueUsd":{"type":["string","null"],"description":"Shares times price per share, USD; null when the filing omits the price"},"priceNote":{"type":["string","null"],"description":"\"price not stated in the filing\" when the filing states no price (the price and the value are then null, never 0; on a cluster, valueUsd is null); \"≈ $61.36, midpoint of the stated range $60.86 to $61.85\" when the price is the midpoint of a range the filing states (pricePerShare is that midpoint); otherwise null"},"company":{"type":["string","null"],"description":"Company name from the SEC ticker list"},"insiders":{"type":"number","description":"Distinct insiders who bought on the open market in the window"},"trades":{"type":"number","description":"Open-market purchase transactions in the window"},"firstTxDate":{"type":"string","format":"date","description":"Earliest purchase in the window"},"latestTxDate":{"type":"string","format":"date","description":"Latest purchase in the window"},"latestFiledAt":{"type":["string","null"],"description":"When the latest of those filings reached EDGAR"},"buyers":{"type":"array","description":"Up to five buyers, largest first","items":{"type":"object","properties":{"name":{"type":"string","description":"Insider name as filed"},"title":{"type":["string","null"],"description":"Role at the company, when the filing gives one"},"valueUsd":{"type":["number","null"],"description":"That insider's combined purchases in the window, counting the trades whose price is stated; null when none of them states a price"},"priceNote":{"type":["string","null"],"description":"\"price not stated in the filing\" when buyers[].valueUsd is null; otherwise null"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/insiders/{ticker}":{"get":{"summary":"SEC Form 4 trades for one ticker","externalDocs":{"url":"https://xoomar.com/markets/api/insiders"},"description":"Transactions for the ticker, newest first (object with ticker and transactions); history starts in 2020 and the free API returns the last six months. A row whose filing states no price has pricePerShare and valueUsd null and priceNote \"price not stated in the filing\"; a price given as a range of the filing is its midpoint, marked approximate in priceNote. Docs: https://xoomar.com/markets/api/insiders","operationId":"insiders_ticker","tags":["Companies"],"parameters":[{"name":"ticker","in":"path","required":true,"description":"US ticker","schema":{"type":"string"},"example":"AAPL"},{"name":"from","in":"query","required":false,"description":"First transaction date (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-01-01"},{"name":"to","in":"query","required":false,"description":"Last transaction date (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-01-01"},{"name":"limit","in":"query","required":false,"description":"Rows returned, newest first inside the window (default 200, max 2000)","schema":{"type":"integer"},"example":200}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"ticker":{"type":["string","null"],"description":"Trading symbol of the issuer, when reported in the filing"},"insiderName":{"type":"string","description":"Reporting officer, director, or 10% owner"},"insiderTitle":{"type":["string","null"],"description":"Role at the company (CEO, CFO, Director...)"},"txDate":{"type":"string","format":"date","description":"Transaction date from the filing, YYYY-MM-DD"},"shares":{"type":["string","null"],"description":"Shares bought or sold"},"pricePerShare":{"type":["string","null"],"description":"Reported price per share in USD"},"valueUsd":{"type":["string","null"],"description":"Shares times price per share, USD; null when the filing omits the price"},"priceNote":{"type":["string","null"],"description":"\"price not stated in the filing\" when the filing states no price (the price and the value are then null, never 0; on a cluster, valueUsd is null); \"≈ $61.36, midpoint of the stated range $60.86 to $61.85\" when the price is the midpoint of a range the filing states (pricePerShare is that midpoint); otherwise null"},"company":{"type":["string","null"],"description":"Company name from the SEC ticker list"},"insiders":{"type":"number","description":"Distinct insiders who bought on the open market in the window"},"trades":{"type":"number","description":"Open-market purchase transactions in the window"},"firstTxDate":{"type":"string","format":"date","description":"Earliest purchase in the window"},"latestTxDate":{"type":"string","format":"date","description":"Latest purchase in the window"},"latestFiledAt":{"type":["string","null"],"description":"When the latest of those filings reached EDGAR"},"buyers":{"type":"array","description":"Up to five buyers, largest first","items":{"type":"object","properties":{"name":{"type":"string","description":"Insider name as filed"},"title":{"type":["string","null"],"description":"Role at the company, when the filing gives one"},"valueUsd":{"type":["number","null"],"description":"That insider's combined purchases in the window, counting the trades whose price is stated; null when none of them states a price"},"priceNote":{"type":["string","null"],"description":"\"price not stated in the filing\" when buyers[].valueUsd is null; otherwise null"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/insiders/clusters":{"get":{"summary":"Insider cluster buying: companies with several distinct open-market buyers","externalDocs":{"url":"https://xoomar.com/markets/api/insiders"},"description":"One row per company where at least minInsiders different insiders bought on the open market within the window: buyers, trades, combined value, first and latest trade dates. Sorted by number of insiders, then value. Derived by XOOMAR from Form 4 filings. Docs: https://xoomar.com/markets/api/insiders","operationId":"insiders_clusters","tags":["Companies"],"parameters":[{"name":"days","in":"query","required":false,"description":"Window in days (default 30, max 365)","schema":{"type":"integer"},"example":30},{"name":"minInsiders","in":"query","required":false,"description":"Distinct buyers required, 2 to 20 (default 3)","schema":{"type":"integer"}},{"name":"minUsd","in":"query","required":false,"description":"Combined purchases at or above this, USD (default 0)","schema":{"type":"number"}},{"name":"ticker","in":"query","required":false,"description":"One company","schema":{"type":"string"},"example":"NVDA"},{"name":"limit","in":"query","required":false,"description":"Rows returned, in that order (default 100, max 500)","schema":{"type":"integer"},"example":100}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"ticker":{"type":["string","null"],"description":"Trading symbol of the issuer, when reported in the filing"},"company":{"type":["string","null"],"description":"Company name from the SEC ticker list"},"insiders":{"type":"number","description":"Distinct insiders who bought on the open market in the window"},"trades":{"type":"number","description":"Open-market purchase transactions in the window"},"valueUsd":{"type":["string","null"],"description":"Shares times price per share, USD; null when the filing omits the price"},"priceNote":{"type":["string","null"],"description":"\"price not stated in the filing\" when the filing states no price (the price and the value are then null, never 0; on a cluster, valueUsd is null); \"≈ $61.36, midpoint of the stated range $60.86 to $61.85\" when the price is the midpoint of a range the filing states (pricePerShare is that midpoint); otherwise null"},"shares":{"type":["string","null"],"description":"Shares bought or sold"},"firstTxDate":{"type":"string","format":"date","description":"Earliest purchase in the window"},"latestTxDate":{"type":"string","format":"date","description":"Latest purchase in the window"},"latestFiledAt":{"type":["string","null"],"description":"When the latest of those filings reached EDGAR"},"buyers":{"type":"array","description":"Up to five buyers, largest first","items":{"type":"object","properties":{"name":{"type":"string","description":"Insider name as filed"},"title":{"type":["string","null"],"description":"Role at the company, when the filing gives one"},"valueUsd":{"type":["number","null"],"description":"That insider's combined purchases in the window, counting the trades whose price is stated; null when none of them states a price"},"priceNote":{"type":["string","null"],"description":"\"price not stated in the filing\" when buyers[].valueUsd is null; otherwise null"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/planned-sales":{"get":{"summary":"SEC Form 144 notices of proposed sale","externalDocs":{"url":"https://xoomar.com/markets/api/insiders"},"description":"Docs: https://xoomar.com/markets/api/insiders","operationId":"planned_sales","tags":["Companies"],"parameters":[{"name":"symbol","in":"query","required":false,"description":"US ticker (class shares as BRK-B)","schema":{"type":"string"},"example":"GME"},{"name":"days","in":"query","required":false,"description":"Window in days (default 30, max 365)","schema":{"type":"integer"},"example":30}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"accessionNo":{"type":"string","description":"SEC accession number of the Form 144"},"issuerCik":{"type":"string","description":"Issuer CIK, ten digits"},"issuerName":{"type":"string","description":"Issuer name as filed"},"ticker":{"type":["string","null"],"description":"Issuer ticker"},"personName":{"type":"string","description":"Person for whose account the shares are to be sold"},"relationship":{"type":["string","null"],"description":"Relationship to the issuer, e.g. Officer, Director"},"securityClass":{"type":["string","null"],"description":"Class of securities to be sold"},"broker":{"type":["string","null"],"description":"Broker named in the notice"},"unitsToSell":{"type":["number","null"],"description":"Shares or units to be sold"},"aggregateMarketValue":{"type":["number","null"],"description":"Aggregate market value of the shares to be sold, USD"},"unitsOutstanding":{"type":["number","null"],"description":"Shares or units of the class outstanding"},"approxSaleDate":{"type":["string","null"],"format":"date","description":"Approximate date of sale"},"exchange":{"type":["string","null"],"description":"Exchange named for the sale"},"filedAt":{"type":"string","format":"date","description":"Filing date"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/large-holders":{"get":{"summary":"Schedule 13D and 13G holders above 5%","externalDocs":{"url":"https://xoomar.com/markets/api/insiders"},"description":"Docs: https://xoomar.com/markets/api/insiders","operationId":"large_holders","tags":["Companies"],"parameters":[{"name":"symbol","in":"query","required":false,"description":"US ticker (class shares as BRK-B)","schema":{"type":"string"},"example":"GME"},{"name":"form","in":"query","required":false,"description":"13D (default) or 13G","schema":{"type":"string","enum":["13D","13G"]}},{"name":"days","in":"query","required":false,"description":"Window in days (default 30, max 365)","schema":{"type":"integer"},"example":30},{"name":"new","in":"query","required":false,"description":"1: only new filings, no amendments","schema":{"type":"string","enum":["1"]}},{"name":"sort","in":"query","required":false,"description":"filed (default, newest first) or percent (largest stakes first)","schema":{"type":"string","enum":["filed","percent"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"accessionNo":{"type":"string","description":"SEC accession number of the schedule"},"formType":{"type":"string","description":"SCHEDULE 13D or SCHEDULE 13G, with /A for an amendment"},"amendmentNo":{"type":["number","null"],"description":"Amendment number; null for the original filing"},"issuerCik":{"type":["string","null"],"description":"Issuer CIK, ten digits"},"issuerName":{"type":"string","description":"Issuer name as filed"},"ticker":{"type":["string","null"],"description":"Issuer ticker"},"cusip":{"type":["string","null"],"description":"CUSIP of the class"},"securityClass":{"type":["string","null"],"description":"Title of the class of securities"},"eventDate":{"type":["string","null"],"format":"date","description":"Date of the event that requires the filing"},"reportingPerson":{"type":"string","description":"Reporting person or entity"},"reportingCik":{"type":["string","null"],"description":"Reporting person's CIK, when filed"},"personType":{"type":["string","null"],"description":"Type of reporting person as filed, e.g. IA (investment adviser), IN (individual), CO (corporation)"},"sharesOwned":{"type":["number","null"],"description":"Shares beneficially owned"},"percentOfClass":{"type":["number","null"],"description":"Percent of the class owned"},"filedAt":{"type":"string","format":"date","description":"Filing date"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/funds":{"get":{"summary":"Tracked 13F managers","externalDocs":{"url":"https://xoomar.com/markets/api/funds"},"description":"Docs: https://xoomar.com/markets/api/funds","operationId":"funds","tags":["Companies"],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"slug":{"type":"string","description":"Fund slug for URLs"},"name":{"type":"string","description":"Fund name"},"manager":{"type":"string","description":"Manager"},"cik":{"type":"string","description":"SEC CIK"},"url":{"type":"string","description":"Hub page"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/funds/{slug}":{"get":{"summary":"One manager's latest 13F portfolio","externalDocs":{"url":"https://xoomar.com/markets/api/funds"},"description":"Docs: https://xoomar.com/markets/api/funds","operationId":"funds_slug","tags":["Companies"],"parameters":[{"name":"slug","in":"path","required":true,"description":"Fund slug from /api/markets/funds","schema":{"type":"string"},"example":"berkshire-hathaway"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"fund":{"type":"object","description":"slug, name, manager, and SEC CIK of the fund"},"quarter":{"type":["string","null"],"format":"date","description":"Reporting quarter end, e.g. 2026-03-31"},"holdings":{"type":"array","description":"Lines of the latest filing, largest value first (up to 200)","items":{"type":"object","properties":{"issuerName":{"type":"string","description":"Issuer name as filed"},"ticker":{"type":["string","null"],"description":"Ticker for the CUSIP, where one is known"},"cusip":{"type":["string","null"],"description":"CUSIP as filed"},"putCall":{"type":"string","description":"\"Put\" or \"Call\" for an option the manager holds, \"\" for the shares themselves"},"valueUsd":{"type":"number","description":"Value in US dollars; for a put or call, the value of the shares it covers"},"shares":{"type":["number","null"],"description":"Shares or principal amount; for a put or call, the shares it covers"},"pctOfPortfolio":{"type":["string","null"],"description":"Weight within the filing's total value"},"changeShares":{"type":["number","null"],"description":"Change in shares vs the fund's prior quarter, per security and kind of line; equal to shares for a new position; null when the prior quarter is not on file"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/financials":{"get":{"summary":"Company financials from XBRL","externalDocs":{"url":"https://xoomar.com/markets/api/financials"},"description":"Quarterly and annual income figures and the balance sheet for one ticker. Docs: https://xoomar.com/markets/api/financials","operationId":"financials","tags":["Companies"],"parameters":[{"name":"symbol","in":"query","required":true,"description":"US ticker (class shares as BRK-B)","schema":{"type":"string"},"example":"AAPL"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"quarterly":{"type":"array","description":"Quarterly income rows, oldest first","items":{"type":"object","properties":{"frame":{"type":"string","description":"Calendar quarter frame, e.g. CY2026Q2 (three-month figures); CY2025Q4 with derived=true is fiscal year less the three reported quarters"},"fiscalPeriod":{"type":["string","null"],"description":"The quarter as the company names it, e.g. Q2 FY 2027 for NVIDIA's quarter ended 26 Jul 2026; null when the company's fiscal calendar isn't on file"},"fiscalYear":{"type":["string","null"],"description":"The quarter's fiscal year as the annual rows name it, e.g. FY 2027"},"derived":{"type":"boolean","description":"true for a computed fourth quarter (EPS left empty)"},"revenue":{"type":["number","null"],"description":"Revenues or RevenueFromContractWithCustomerExcludingAssessedTax, USD"},"netIncome":{"type":["number","null"],"description":"NetIncomeLoss, USD"},"epsDiluted":{"type":["number","null"],"description":"EarningsPerShareDiluted (basic when diluted is absent)"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"annual":{"type":"array","description":"Fiscal year rows, oldest first","items":{"type":"object","properties":{"fiscalYear":{"type":"string","description":"The fiscal year as the company names it in its annual report, e.g. FY 2026 for NVIDIA's year ended 25 Jan 2026"},"operatingCashFlow":{"type":["number","null"],"description":"NetCashProvidedByUsedInOperatingActivities for the fiscal year"},"capex":{"type":["number","null"],"description":"Capital expenditure for the fiscal year, USD: PaymentsToAcquirePropertyPlantAndEquipment, or the element the company files it as (PaymentsToAcquireProductiveAssets and others)"},"buybacks":{"type":["number","null"],"description":"PaymentsForRepurchaseOfCommonStock for the fiscal year, USD"},"dividends":{"type":["number","null"],"description":"PaymentsOfDividendsCommonStock or PaymentsOfDividends, USD"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"latest.cash":{"type":["number","null"],"description":"Balance sheet instants at latest.end"},"latest.debt":{"type":["number","null"],"description":"Balance sheet instants at latest.end"},"latest.equity":{"type":["number","null"],"description":"Balance sheet instants at latest.end"},"latest.assets":{"type":["number","null"],"description":"Balance sheet instants at latest.end"},"latest.sharesOutstanding":{"type":["number","null"],"description":"Cover-page shares outstanding at latest.sharesDate"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/buybacks":{"get":{"summary":"Share repurchases from XBRL","externalDocs":{"url":"https://xoomar.com/markets/api/financials"},"description":"Largest share repurchases in each company's latest fiscal year, 100 rows. Docs: https://xoomar.com/markets/api/financials","operationId":"buybacks","tags":["Companies"],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"ticker":{"type":"string","description":"Ticker"},"name":{"type":"string","description":"Company name"},"cik":{"type":"string","description":"SEC CIK"},"frame":{"type":"string","description":"Fiscal year frame, e.g. CY2025"},"end":{"type":"string","format":"date","description":"Fiscal year end"},"buybacks":{"type":"number","description":"PaymentsForRepurchaseOfCommonStock for the fiscal year, USD"},"revenue":{"type":["number","null"],"description":"Revenue for the same fiscal year, USD"},"netIncome":{"type":["number","null"],"description":"Net income for the same fiscal year, USD"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/events":{"get":{"summary":"8-K material events","externalDocs":{"url":"https://xoomar.com/markets/api/events"},"description":"Docs: https://xoomar.com/markets/api/events","operationId":"events","tags":["Companies"],"parameters":[{"name":"ticker","in":"query","required":false,"description":"US ticker","schema":{"type":"string"},"example":"AAPL"},{"name":"item","in":"query","required":false,"description":"8-K item number","schema":{"type":"string"},"example":"5.02"},{"name":"days","in":"query","required":false,"description":"Window in days (default 7, max 90)","schema":{"type":"integer"},"example":7}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"accessionNo":{"type":"string","description":"EDGAR accession number, unique per filing"},"ticker":{"type":["string","null"],"description":"The filer's ticker; null when it has none"},"company":{"type":"string","description":"Company name from the EDGAR index"},"items":{"type":["array","null"],"items":{},"description":"8-K item numbers (2.02, 5.02...)"},"eventLabels":{"type":["array","null"],"items":{},"description":"Readable labels for each item"},"filedAt":{"type":"string","format":"date-time","description":"SEC acceptance timestamp"},"docUrl":{"type":"string","description":"Link to the filing index on sec.gov"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/earnings":{"get":{"summary":"Earnings calendar: reported 8-K Item 2.02 dates and estimates","externalDocs":{"url":"https://xoomar.com/markets/api/earnings"},"description":"Default: today to fourteen days ahead. Reported rows are 8-K Item 2.02 filings; an estimated row is an expected date, shown until the company's 8-K confirms it. The free API reaches back six months. Docs: https://xoomar.com/markets/api/earnings","operationId":"earnings","tags":["Companies"],"parameters":[{"name":"from","in":"query","required":false,"description":"First date (default today) (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-01-01"},{"name":"to","in":"query","required":false,"description":"Last date (default from + 14 days; at most 120 days) (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-01-01"},{"name":"status","in":"query","required":false,"description":"One kind of row","schema":{"type":"string","enum":["reported","estimated"]}},{"name":"ticker","in":"query","required":false,"description":"One company","schema":{"type":"string"},"example":"NVDA"},{"name":"limit","in":"query","required":false,"description":"Rows returned, earliest date first (default 500, max 2000)","schema":{"type":"integer"},"example":500}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date","description":"The reported date (filing date of the 8-K) or the estimated date"},"ticker":{"type":"string","description":"Ticker as EDGAR maps it (class shares as BRK-B)"},"company":{"type":"string","description":"Filer name as on the filing"},"cik":{"type":"string","description":"SEC Central Index Key of the filer"},"status":{"type":"string","description":"reported (an 8-K with Item 2.02 on EDGAR) or estimated (an expected date, shown until the company's 8-K arrives)"},"basis":{"type":["string","null"],"format":"date","description":"Reference date for an estimated row; null for reported rows"},"accessionNo":{"type":["string","null"],"description":"The filing's accession number for reported rows; null for estimates"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/earnings/{ticker}":{"get":{"summary":"One company's reported earnings dates and the next estimate","externalDocs":{"url":"https://xoomar.com/markets/api/earnings"},"description":"Docs: https://xoomar.com/markets/api/earnings","operationId":"earnings_ticker","tags":["Companies"],"parameters":[{"name":"ticker","in":"path","required":true,"description":"US ticker","schema":{"type":"string"},"example":"NVDA"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"ticker":{"type":"string","description":"Ticker as EDGAR maps it (class shares as BRK-B)"},"company":{"type":"string","description":"Filer name as on the filing"},"cik":{"type":"string","description":"SEC Central Index Key of the filer"},"history":{"type":"array","items":{},"description":"Reported dates newest first: { date, accessionNo }, up to 80"},"next":{"type":["object","null"],"description":"{ date, status: estimated, basis } for the next expected report, or null"},"lastReported":{"type":["string","null"],"format":"date","description":"Newest reported date"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/structured-products":{"get":{"summary":"424B2 structured note filings","externalDocs":{"url":"https://xoomar.com/markets/api/structured-products"},"description":"Docs: https://xoomar.com/markets/api/structured-products","operationId":"structured_products","tags":["Companies"],"parameters":[{"name":"issuer","in":"query","required":false,"description":"Issuer name filter","schema":{"type":"string"}},{"name":"underlying","in":"query","required":false,"description":"Underlying symbol","schema":{"type":"string"},"example":"SPX"},{"name":"noteType","in":"query","required":false,"description":"Note type","schema":{"type":"string","enum":["autocallable","buffered","barrier","income"]}},{"name":"minCoupon","in":"query","required":false,"description":"Lowest annual coupon in percent (priced notes only)","schema":{"type":"number"}},{"name":"maxCoupon","in":"query","required":false,"description":"Highest annual coupon in percent (priced notes only)","schema":{"type":"number"}},{"name":"days","in":"query","required":false,"description":"Window in days (default 30, max 365)","schema":{"type":"integer"},"example":30},{"name":"cursor","in":"query","required":false,"description":"Paging cursor: nextCursor from the previous page","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"accessionNo":{"type":"string","description":"EDGAR accession number, unique per filing"},"issuer":{"type":"string","description":"Filing entity (BofA Finance, Morgan Stanley Finance...)"},"formType":{"type":"string","description":"424B2 or FWP"},"filedAt":{"type":"string","format":"date","description":"Filing date, YYYY-MM-DD"},"pricingDate":{"type":["string","null"],"description":"Pricing/trade date when stated"},"underlyings":{"type":["array","null"],"items":{},"description":"Parsed underlying symbols (SPX, NDX, NVDA...). Populated for priced notes; preliminary filings carry nulls"},"noteType":{"type":["string","null"],"description":"autocallable, buffered, barrier, or income. Populated for priced notes; preliminary filings carry nulls"},"coupon":{"type":["string","null"],"description":"Annual coupon %; null on preliminary filings, which are filed before the rate is set"},"capPct":{"type":["string","null"],"description":"Maximum return as % of initial level when the note is capped"},"barrierPct":{"type":["string","null"],"description":"Barrier/threshold as % of initial level. Populated for priced notes; preliminary filings carry nulls"},"principalUsd":{"type":["string","null"],"description":"Aggregate principal when stated (final filings)"},"docUrl":{"type":"string","description":"Link to the primary SEC document"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"nextCursor":{"type":["string","null"],"description":"Send it back as cursor for the next 200 rows; null on the last page"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/federal-contracts":{"get":{"summary":"US federal contract actions by listed parent","externalDocs":{"url":"https://xoomar.com/markets/api/federal-contracts"},"description":"Docs: https://xoomar.com/markets/api/federal-contracts","operationId":"federal_contracts","tags":["Companies"],"parameters":[{"name":"ticker","in":"query","required":false,"description":"US ticker","schema":{"type":"string"},"example":"LMT"},{"name":"days","in":"query","required":false,"description":"Window in days (default 7, max 365)","schema":{"type":"integer"},"example":7},{"name":"by","in":"query","required":false,"description":"ticker: obligations summed by listed parent","schema":{"type":"string","enum":["ticker"]}},{"name":"listed","in":"query","required":false,"description":"1: only recipients with a listed parent","schema":{"type":"string","enum":["1"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"actionDate":{"type":"string","description":"Date the action was signed"},"awardId":{"type":"string","description":"Contract or order number (PIID)"},"mod":{"type":["string","null"],"description":"Modification number; 0 or null is the original award"},"actionType":{"type":["string","null"],"description":"FPDS action type code"},"amountUsd":{"type":"number","description":"Dollars obligated by this action; negative for de-obligations"},"recipientName":{"type":"string","description":"Recipient legal name as registered"},"ticker":{"type":["string","null"],"description":"Ticker of the recipient's listed parent; null when private or not matched"},"awardingAgency":{"type":["string","null"],"description":"Awarding department and bureau"},"awardingSubAgency":{"type":["string","null"],"description":"Awarding department and bureau"},"awardType":{"type":["string","null"],"description":"Definitive contract, delivery order, BPA call, purchase order"},"naicsCode":{"type":["string","null"],"description":"Industry code of the work"},"description":{"type":["string","null"],"description":"Agency's description of the action, up to 1,000 characters"},"generatedId":{"type":["string","null"],"description":"USAspending award id; https://www.usaspending.gov/award/{generatedId}"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/startup-funding":{"get":{"summary":"SEC Form D private placements","externalDocs":{"url":"https://xoomar.com/markets/api/startup-funding"},"description":"Docs: https://xoomar.com/markets/api/startup-funding","operationId":"startup_funding","tags":["Companies"],"parameters":[{"name":"days","in":"query","required":false,"description":"Window in days (default 30, max 365)","schema":{"type":"integer"},"example":30},{"name":"cik","in":"query","required":false,"description":"One issuer by CIK","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"description":"Most recent filings instead of largest raises","schema":{"type":"string","enum":["recent"]}},{"name":"funds","in":"query","required":false,"description":"1: pooled investment funds instead of operating companies","schema":{"type":"string","enum":["1"]}},{"name":"amendments","in":"query","required":false,"description":"1: include amendments (Form D/A)","schema":{"type":"string","enum":["1"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"accessionNo":{"type":"string","description":"EDGAR accession number; the filing is at /Archives/edgar/data/{cik}/{accession without dashes}/"},"cik":{"type":"string","description":"Issuer CIK, ten digits"},"issuerName":{"type":"string","description":"Issuer as filed"},"entityType":{"type":["string","null"],"description":"Corporation, Limited Partnership, LLC, Trust and so on"},"state":{"type":["string","null"],"description":"Issuer state or country code"},"industryGroup":{"type":["string","null"],"description":"SEC industry category (Pooled Investment Fund for funds)"},"fundType":{"type":["string","null"],"description":"Hedge, Private Equity, Venture Capital or Other Investment Fund, funds only"},"isAmendment":{"type":"boolean","description":"Form D/A"},"dateOfFirstSale":{"type":["string","null"],"description":"ISO date; null when the first sale has yet to occur"},"securityTypes":{"type":["string","null"],"description":"equity, debt, options, pooled fund, other"},"exemptions":{"type":["string","null"],"description":"Rule items claimed, e.g. 06b, 06c, 3C.1, 3C.7"},"totalOfferingAmount":{"type":["number","null"],"description":"USD; null when indefinite"},"totalAmountSold":{"type":["number","null"],"description":"USD sold as of the filing"},"investorsCount":{"type":["number","null"],"description":"Investors who have already invested"},"minimumInvestment":{"type":["number","null"],"description":"USD minimum accepted from an outside investor"},"revenueRange":{"type":["string","null"],"description":"Issuer revenue range or fund net asset value range, as disclosed"},"filedAt":{"type":"string","description":"EDGAR filing date"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/ipos":{"get":{"summary":"IPO pipeline (S-1, F-1, 424B4, EFFECT, RW)","externalDocs":{"url":"https://xoomar.com/markets/api/ipos"},"description":"Docs: https://xoomar.com/markets/api/ipos","operationId":"ipos","tags":["Companies"],"parameters":[{"name":"form","in":"query","required":false,"description":"Form types, comma-separated: S-1, S-1/A, F-1, F-1/A, 424B4, RW, EFFECT (default S-1,F-1)","schema":{"type":"string"},"example":"S-1,F-1"},{"name":"days","in":"query","required":false,"description":"Window in days (default 90, max 365)","schema":{"type":"integer"},"example":90},{"name":"new","in":"query","required":false,"description":"1: only filers not on the SEC ticker list (new issuers)","schema":{"type":"string","enum":["1"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"accessionNo":{"type":"string","description":"EDGAR accession number"},"formType":{"type":"string","description":"S-1, S-1/A, F-1, F-1/A, 424B4, RW or EFFECT"},"cik":{"type":"string","description":"Filer CIK, ten digits"},"companyName":{"type":"string","description":"Filer name as on EDGAR"},"filedAt":{"type":"string","description":"EDGAR filing date"},"listed":{"type":"boolean","description":"Filer is on the SEC's listed-ticker table today; a company that has priced is listed by now"},"firstRegistration":{"type":["string","null"],"description":"Earliest S-1 or F-1 on file for the filer; a 424B4 weeks after it is an IPO pricing"},"offeringAmount":{"type":["number","null"],"description":"Always null; offering amounts are not included"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/bitcoin-treasuries":{"get":{"summary":"Bitcoin held by public companies (XBRL)","externalDocs":{"url":"https://xoomar.com/markets/api/bitcoin-treasuries"},"description":"Docs: https://xoomar.com/markets/api/bitcoin-treasuries","operationId":"bitcoin_treasuries","tags":["Companies"],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"ticker":{"type":"string","description":"Listed ticker"},"name":{"type":"string","description":"Company"},"cik":{"type":"string","description":"SEC CIK, ten digits"},"asOf":{"type":["string","null"],"description":"Balance sheet date of the figures"},"units":{"type":["number","null"],"description":"Bitcoin held as tagged in the filing; null when the filing gives no usable count"},"fairValueUsd":{"type":["number","null"],"description":"Fair value of crypto assets as filed, USD"},"costUsd":{"type":["number","null"],"description":"Cost basis as filed, USD"},"form":{"type":["string","null"],"description":"10-Q or 10-K the figures come from"},"unitsReliable":{"type":"boolean","description":"true when the filing gives a usable coin count"},"impliedPrice":{"type":["number","null"],"description":"fairValueUsd divided by units, the filing's own valuation per coin"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/funding-rates":{"get":{"summary":"Perpetual funding rates, all tracked symbols on five venues","externalDocs":{"url":"https://xoomar.com/markets/api/funding-rates"},"description":"Docs: https://xoomar.com/markets/api/funding-rates","operationId":"funding_rates","tags":["Crypto"],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"slug":{"type":"string","description":"Symbol slug used in URLs (btc, eth, sol...)"},"baseAsset":{"type":"string","description":"Base asset ticker (BTC, ETH...)"},"exchange":{"type":"string","description":"binance, bybit, okx, hyperliquid or kraken"},"markPrice":{"type":["string","null"],"description":"Latest mark price in USD"},"fundingRate":{"type":["string","null"],"description":"Current funding rate as published, a decimal per settlement interval (0.0001 = 0.01% per interval)"},"fundingIntervalHours":{"type":"number","description":"Hours per settlement: 8 (Binance, Bybit, OKX) or 1 (Hyperliquid, Kraken)"},"fundingRate8h":{"type":["number","null"],"description":"The rate scaled to eight hours, comparable across venues"},"fundingAnnualized":{"type":["number","null"],"description":"Annualized rate, simple (not compounded), from the rate and its funding interval"},"nextFundingTime":{"type":["string","null"],"description":"ISO timestamp of the next funding settlement"},"openInterest":{"type":["string","null"],"description":"Open interest in contracts"},"openInterestValue":{"type":["string","null"],"description":"Open interest notional in USD"},"priceChangePct24h":{"type":["string","null"],"description":"24h price change as a decimal"},"longShortRatio":{"type":["string","null"],"description":"Global long/short account ratio where the venue publishes it, else null"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/funding-rates/{slug}":{"get":{"summary":"One symbol's funding on every venue, with history","externalDocs":{"url":"https://xoomar.com/markets/api/funding-rates"},"description":"The current rate on every venue; with history, up to 5,000 settled rates across venues, newest first. Docs: https://xoomar.com/markets/api/funding-rates","operationId":"funding_rates_slug","tags":["Crypto"],"parameters":[{"name":"slug","in":"path","required":true,"description":"Symbol slug from /api/markets/symbols","schema":{"type":"string"},"example":"btc"},{"name":"history","in":"query","required":false,"description":"Settled funding history window","schema":{"type":"string","enum":["30d","1y","all"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"slug":{"type":"string","description":"Symbol slug used in URLs (btc, eth, sol...)"},"baseAsset":{"type":"string","description":"Base asset ticker (BTC, ETH...)"},"exchange":{"type":"string","description":"binance, bybit, okx, hyperliquid or kraken"},"markPrice":{"type":["string","null"],"description":"Latest mark price in USD"},"fundingRate":{"type":["string","null"],"description":"Current funding rate as published, a decimal per settlement interval (0.0001 = 0.01% per interval)"},"fundingIntervalHours":{"type":"number","description":"Hours per settlement: 8 (Binance, Bybit, OKX) or 1 (Hyperliquid, Kraken)"},"fundingRate8h":{"type":["number","null"],"description":"The rate scaled to eight hours, comparable across venues"},"fundingAnnualized":{"type":["number","null"],"description":"Annualized rate, simple (not compounded), from the rate and its funding interval"},"nextFundingTime":{"type":["string","null"],"description":"ISO timestamp of the next funding settlement"},"openInterest":{"type":["string","null"],"description":"Open interest in contracts"},"openInterestValue":{"type":["string","null"],"description":"Open interest notional in USD"},"priceChangePct24h":{"type":["string","null"],"description":"24h price change as a decimal"},"longShortRatio":{"type":["string","null"],"description":"Global long/short account ratio where the venue publishes it, else null"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/open-interest/{slug}":{"get":{"summary":"Hourly open interest history","externalDocs":{"url":"https://xoomar.com/markets/api/open-interest"},"description":"Open interest history per symbol from Binance, hourly or daily; history starts in 2021 and the free API returns the last six months. Live open interest per venue is in /api/markets/funding-rates. Docs: https://xoomar.com/markets/api/open-interest","operationId":"open_interest_slug","tags":["Crypto"],"parameters":[{"name":"slug","in":"path","required":true,"description":"Symbol slug","schema":{"type":"string"},"example":"btc"},{"name":"from","in":"query","required":false,"description":"First hour (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-01-01"},{"name":"to","in":"query","required":false,"description":"Last hour (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-01-01"},{"name":"period","in":"query","required":false,"description":"1h (default) or 1d","schema":{"type":"string","enum":["1h","1d"]}},{"name":"limit","in":"query","required":false,"description":"Rows returned, newest first inside the window (default 5000, max 5000)","schema":{"type":"integer"},"example":5000}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"exchange":{"type":"string","description":"binance (hourly history)"},"ts":{"type":"string","description":"Observation hour (ISO timestamp)"},"openInterest":{"type":["string","null"],"description":"Open interest in contracts"},"openInterestValue":{"type":["string","null"],"description":"Open interest notional in USD"},"longShortRatio":{"type":["string","null"],"description":"Global long/short account ratio where available"},"topTraderRatio":{"type":["string","null"],"description":"Top trader long/short positions ratio where available"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/liquidations":{"get":{"summary":"24-hour liquidation summary","externalDocs":{"url":"https://xoomar.com/markets/api/liquidations"},"description":"Docs: https://xoomar.com/markets/api/liquidations","operationId":"liquidations","tags":["Crypto"],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"period":{"type":"string","description":"Aggregation window, currently 24h"},"totalUsd":{"type":"number","description":"Total liquidated notional in USD over the period"},"longUsd":{"type":"number","description":"Liquidated long positions in USD (forced sales)"},"shortUsd":{"type":"number","description":"Liquidated short positions in USD (forced buys)"},"maxSingleUsd":{"type":"number","description":"Largest single liquidation in the period"},"hourly":{"type":"array","items":{},"description":"24 buckets: hour (ISO), longUsd, shortUsd, count"},"topSymbols":{"type":"array","items":{},"description":"Ten most liquidated contracts: symbol, longUsd, shortUsd, totalUsd, count"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/liquidations/recent":{"get":{"summary":"Individual liquidation events, newest first","externalDocs":{"url":"https://xoomar.com/markets/api/liquidations"},"description":"Docs: https://xoomar.com/markets/api/liquidations","operationId":"liquidations_recent","tags":["Crypto"],"parameters":[{"name":"symbol","in":"query","required":false,"description":"Contract (BTC alone matches BTCUSDT)","schema":{"type":"string"},"example":"BTCUSDT"},{"name":"exchange","in":"query","required":false,"description":"Exchange","schema":{"type":"string","enum":["okx","gate","htx"]}},{"name":"side","in":"query","required":false,"description":"Side","schema":{"type":"string","enum":["long","short"]}},{"name":"minUsd","in":"query","required":false,"description":"Minimum notional in USD","schema":{"type":"number"},"example":100000},{"name":"limit","in":"query","required":false,"description":"Rows returned, newest first inside the window (default 100, max 500)","schema":{"type":"integer"},"example":100}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"Event id"},"rawSymbol":{"type":"string","description":"Contract as the exchange names it"},"side":{"type":"string","description":"long (forced sale) or short (forced buy)"},"price":{"type":"string","description":"Liquidation price"},"qty":{"type":"string","description":"Quantity in coins"},"usdValue":{"type":"string","description":"Notional in USD"},"exchange":{"type":"string","description":"okx, gate or htx"},"ts":{"type":"string","format":"date-time","description":"Event time, ISO"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/liquidations/history":{"get":{"summary":"Hourly liquidation totals","externalDocs":{"url":"https://xoomar.com/markets/api/liquidations"},"description":"History starts on 3 July 2026; the free API returns the last six months. Docs: https://xoomar.com/markets/api/liquidations","operationId":"liquidations_history","tags":["Crypto"],"parameters":[{"name":"symbol","in":"query","required":false,"description":"Contract (BTC alone matches BTCUSDT)","schema":{"type":"string"},"example":"BTCUSDT"},{"name":"from","in":"query","required":false,"description":"First hour (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-01-01"},{"name":"to","in":"query","required":false,"description":"Last hour (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-01-01"},{"name":"limit","in":"query","required":false,"description":"Rows returned, newest first inside the window (default 168, max 5000)","schema":{"type":"integer"},"example":168}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"hour":{"type":"string","format":"date-time","description":"Hour bucket, ISO"},"symbol":{"type":"string","description":"Contract (only when filtered)"},"longUsd":{"type":"number","description":"Long liquidations in USD"},"shortUsd":{"type":"number","description":"Short liquidations in USD"},"totalUsd":{"type":"number","description":"Total in USD"},"count":{"type":"number","description":"Events"},"maxSingleUsd":{"type":"number","description":"Largest single event"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/options/{currency}":{"get":{"summary":"Deribit options metrics","externalDocs":{"url":"https://xoomar.com/markets/api/options"},"description":"Total open interest, put/call ratio, DVOL and per-expiry max pain for BTC or ETH. Docs: https://xoomar.com/markets/api/options","operationId":"options_currency","tags":["Crypto"],"parameters":[{"name":"currency","in":"path","required":true,"description":"Currency","schema":{"type":"string","enum":["BTC","ETH"]},"example":"BTC"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"currency":{"type":"string","description":"BTC or ETH"},"underlyingPrice":{"type":"number","description":"Deribit index price of the underlying as of updatedAt"},"updatedAt":{"type":"string","description":"The time the figures are as of, ISO"},"totalOI":{"type":"number","description":"Total open interest across all strikes, in contracts"},"pcRatio":{"type":"number","description":"Put/call open interest ratio across all expiries"},"dvol":{"type":["number","null"],"description":"Deribit implied volatility index (crypto VIX)"},"expiries":{"type":"array","description":"Per-expiry summaries for the nearest 10 expiries, nearest first","items":{"type":"object","properties":{"expiry":{"type":"string","format":"date","description":"Expiry date YYYY-MM-DD"},"maxPain":{"type":["number","null"],"description":"The strike at which the total payout to option holders at expiry would be smallest"},"totalOI":{"type":"number","description":"Open interest for that expiry"},"pcRatio":{"type":"number","description":"Put/call ratio for that expiry"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/options/{currency}/dvol":{"get":{"summary":"DVOL history","externalDocs":{"url":"https://xoomar.com/markets/api/options"},"description":"Hourly DVOL candles, newest first; history starts in 2021 and the free API returns the last six months. Docs: https://xoomar.com/markets/api/options","operationId":"options_currency_dvol","tags":["Crypto"],"parameters":[{"name":"currency","in":"path","required":true,"description":"Currency","schema":{"type":"string","enum":["BTC","ETH"]},"example":"BTC"},{"name":"from","in":"query","required":false,"description":"First hour (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-01-01"},{"name":"to","in":"query","required":false,"description":"Last hour (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-01-01"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"currency":{"type":"string","description":"BTC or ETH"},"candles":{"type":"array","items":{},"description":"Hourly DVOL candles: ts, open, high, low, close"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/whales":{"get":{"summary":"Largest Hyperliquid whale positions","externalDocs":{"url":"https://xoomar.com/markets/api/whales"},"description":"Docs: https://xoomar.com/markets/api/whales","operationId":"whales","tags":["Crypto"],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"positions":{"type":"array","description":"Top 20 open positions among tracked whale wallets, largest first","items":{"type":"object","properties":{"wallet":{"type":"string","description":"Shortened wallet address (0xd4c1...3d1d)"},"coin":{"type":"string","description":"Asset symbol on Hyperliquid (BTC, ETH, SOL...)"},"side":{"type":"string","description":"long or short"},"size":{"type":"number","description":"Position notional in USD at entry price"},"uPnl":{"type":"number","description":"Unrealized PnL in USD as reported by Hyperliquid"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/whales/{coin}":{"get":{"summary":"Whale positions in one coin","externalDocs":{"url":"https://xoomar.com/markets/api/whales"},"description":"Docs: https://xoomar.com/markets/api/whales","operationId":"whales_coin","tags":["Crypto"],"parameters":[{"name":"coin","in":"path","required":true,"description":"Coin","schema":{"type":"string"},"example":"btc"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"positions":{"type":"array","description":"Top 20 open positions among tracked whale wallets, largest first","items":{"type":"object","properties":{"wallet":{"type":"string","description":"Shortened wallet address (0xd4c1...3d1d)"},"coin":{"type":"string","description":"Asset symbol on Hyperliquid (BTC, ETH, SOL...)"},"side":{"type":"string","description":"long or short"},"size":{"type":"number","description":"Position notional in USD at entry price"},"uPnl":{"type":"number","description":"Unrealized PnL in USD as reported by Hyperliquid"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/sentiment":{"get":{"summary":"Latest sentiment scores for every tracked asset","externalDocs":{"url":"https://xoomar.com/markets/api/sentiment"},"description":"Docs: https://xoomar.com/markets/api/sentiment","operationId":"sentiment","tags":["Crypto"],"parameters":[{"name":"window","in":"query","required":false,"description":"Window of the scores (default 24h)","schema":{"type":"string","enum":["5m","15m","1h","24h","7d","30d"]}},{"name":"asset","in":"query","required":false,"description":"One asset slug","schema":{"type":"string"},"example":"btc"},{"name":"kind","in":"query","required":false,"description":"One asset class","schema":{"type":"string","enum":["crypto","fx","index","commodity","equity"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"totalAssets":{"type":"number","description":"Assets in the response"},"window":{"type":"string","description":"Window of the scores: 5m, 15m, 1h, 24h (default), 7d or 30d"},"cadence":{"type":"string","description":"How often the scores update"},"data":{"type":"array","description":"One record per asset, latest scores","items":{"type":"object","properties":{"slug":{"type":"string","description":"Asset slug (btc, gold, sp500...)"},"name":{"type":"string","description":"Display name"},"kind":{"type":"string","description":"crypto, fx, index, commodity or equity"},"window":{"type":"string","description":"The window of this record"},"timestamp":{"type":"string","description":"When this score was computed (ISO)"},"compositeScore":{"type":"number","description":"One reading from -1 to +1 for the asset; higher is more bullish"},"sentimentLabel":{"type":"string","description":"BULLISH, NEUTRAL or BEARISH: the band compositeScore falls in"},"newsLayer":{"type":"object","description":"{ score, articlesCount }: tone of recent headlines about the asset, -1 to +1, and how many headlines it covers"},"crowdLayer":{"type":"object","description":"{ score }: how traders are leaning on the exchanges right now (for stocks, how heavily the stock is sold short), -1 to +1; null where it doesn't apply"},"institutionalLayer":{"type":"object","description":"{ score }: institutional positioning from the CFTC report, -1 to +1; null where no CFTC market covers the asset"},"fearGreedIndex":{"type":["number","null"],"description":"Crypto Fear & Greed Index by alternative.me (crypto assets only; credit alternative.me next to the value when you show it)"},"divergenceAlert":{"type":"object","description":"{ signal, message }: a note when the components point different ways, or agree strongly"},"metadata":{"type":"object","description":"{ sampleHeadlines }: up to three recent headlines about the asset, each with its tone from -1 to +1"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/sentiment/{slug}":{"get":{"summary":"Sentiment history for one asset","externalDocs":{"url":"https://xoomar.com/markets/api/sentiment"},"description":"Docs: https://xoomar.com/markets/api/sentiment","operationId":"sentiment_slug","tags":["Crypto"],"parameters":[{"name":"slug","in":"path","required":true,"description":"Asset slug","schema":{"type":"string"},"example":"btc"},{"name":"history","in":"query","required":false,"description":"Series to return: 7d (default) or 30d; all returns the 30d series","schema":{"type":"string","enum":["7d","30d","all"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"ts":{"type":"string","format":"date-time","description":"Score time"},"window":{"type":"string","description":"Window of the series: 7d or 30d"},"composite":{"type":["string","null"],"description":"One reading from -1 to +1 for the asset; higher is more bullish"},"newsScore":{"type":["string","null"],"description":"Tone of recent headlines about the asset, -1 to +1"},"newsCount":{"type":["number","null"],"description":"Headlines in the window"},"crowdScore":{"type":["string","null"],"description":"Crowd positioning, -1 to +1; null where it doesn't apply"},"institutionalScore":{"type":["string","null"],"description":"Institutional positioning from the CFTC report, -1 to +1; null where no CFTC market covers the asset"},"fearGreed":{"type":["number","null"],"description":"Crypto Fear & Greed Index by alternative.me; credit alternative.me next to the value when you show it"},"divergenceSignal":{"type":["string","null"],"description":"Label when the components point different ways, or agree strongly"},"divergenceMessage":{"type":["string","null"],"description":"Plain note for that label"},"metadata":{"type":"object","description":"Sample headlines about the asset"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/signals/{slug}":{"get":{"summary":"Composite reading for one asset","externalDocs":{"url":"https://xoomar.com/markets/api/signals"},"description":"Docs: https://xoomar.com/markets/api/signals","operationId":"signals_slug","tags":["Crypto"],"parameters":[{"name":"slug","in":"path","required":true,"description":"Asset slug","schema":{"type":"string"},"example":"btc"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"asset":{"type":"object","description":"{ slug, name, kind }"},"news":{"type":"object","description":"{ score, articleCount, window }: tone of recent headlines about the asset, -1 to +1, how many headlines it covers, and the window (24h)"},"crowd":{"type":["object","null"],"description":"{ fundingRate, fundingPercentile30d, longShortRatio, score }: the current funding rate, its rank from 0 to 100 against its own recent history, and the crowd score (-1 to +1), where a high reading means traders are paying more than usual to hold longs in that asset and a low reading less than usual; longShortRatio is reserved and null; null for assets without a perpetual"},"institutional":{"type":["object","null"],"description":"{ cotNetPosition, cotIndex1y, reportDate, score }: the net position in contracts of leveraged funds (managed money for commodities), its rank from 0 to 100 against its own history, the CFTC report date, and the institutional score (-1 to +1); null without a CFTC market"},"macro":{"type":"object","description":"{ fearGreed }: the Crypto Fear & Greed Index by alternative.me; credit alternative.me next to the value when you show it"},"composite":{"type":["number","null"],"description":"One reading from -1 to +1 for the asset; higher is more bullish; null when no component has data"},"updatedAt":{"type":"object","description":"{ news, crowd, institutional }: when each component last changed"},"disclaimer":{"type":"string","description":"Informational only. Not financial advice."},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/etf-flows":{"get":{"summary":"Spot BTC and ETH ETF flows and holdings","externalDocs":{"url":"https://xoomar.com/markets/api/etf-flows"},"description":"From the issuers' own daily holdings files: iShares, Bitwise and ARK 21Shares for bitcoin, iShares and Bitwise for ether. History from 20 August 2026. Docs: https://xoomar.com/markets/api/etf-flows","operationId":"etf_flows","tags":["Crypto"],"parameters":[{"name":"asset","in":"query","required":false,"description":"Asset","schema":{"type":"string","enum":["btc","eth"]}},{"name":"days","in":"query","required":false,"description":"Window in days (default 90, max 730)","schema":{"type":"integer"},"example":90}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date","description":"The as-of date of the issuer file"},"ticker":{"type":"string","description":"Fund ticker (IBIT, ETHA...)"},"issuer":{"type":"string","description":"Issuer name"},"asset":{"type":"string","description":"btc or eth"},"holdings":{"type":["string","null"],"description":"Coins held per the issuer file"},"flowUsd":{"type":["string","null"],"description":"Net flow for the day in USD, derived from the change in the fund's reported holdings"},"aumUsd":{"type":["string","null"],"description":"Holdings valued in USD"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/symbols":{"get":{"summary":"Tracked crypto symbols and each venue's instrument id","externalDocs":{"url":"https://xoomar.com/markets/api/funding-rates"},"description":"Docs: https://xoomar.com/markets/api/funding-rates","operationId":"symbols","tags":["Crypto"],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"slug":{"type":"string","description":"Slug used in URLs"},"baseAsset":{"type":"string","description":"Base asset"},"binanceSymbol":{"type":["string","null"],"description":"Binance symbol"},"bybitSymbol":{"type":["string","null"],"description":"Bybit symbol"},"okxInstId":{"type":["string","null"],"description":"OKX instrument id"},"hyperliquidCoin":{"type":["string","null"],"description":"Hyperliquid coin"},"krakenSymbol":{"type":["string","null"],"description":"Kraken Futures symbol"},"bitmexSymbol":{"type":["string","null"],"description":"Always null, kept so existing clients parse unchanged"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/cot":{"get":{"summary":"CFTC Commitments of Traders, latest report for every market","externalDocs":{"url":"https://xoomar.com/markets/api/cot"},"description":"Docs: https://xoomar.com/markets/api/cot","operationId":"cot","tags":["Macro"],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"slug":{"type":"string","description":"Market slug for URLs (euro-fx, gold...)"},"name":{"type":"string","description":"CFTC contract market name"},"group":{"type":"string","description":"currencies, indices, crypto, metals, energy, bonds, agriculture, other"},"reportType":{"type":"string","description":"tff (financial futures) or disagg (commodities)"},"sortRank":{"type":"number","description":"Display order within the group"},"reportDate":{"type":"string","format":"date","description":"CFTC report Tuesday, YYYY-MM-DD"},"openInterest":{"type":["number","null"],"description":"Total open interest in contracts"},"dealerLong":{"type":["number","null"],"description":"Dealers and intermediaries (tff); producers, merchants, processors and users (disagg)"},"dealerShort":{"type":["number","null"],"description":"Dealers and intermediaries (tff); producers, merchants, processors and users (disagg)"},"assetMgrLong":{"type":["number","null"],"description":"Asset managers and institutional investors (tff); swap dealers (disagg)"},"assetMgrShort":{"type":["number","null"],"description":"Asset managers and institutional investors (tff); swap dealers (disagg)"},"levFundLong":{"type":["number","null"],"description":"Leveraged funds (tff); managed money (disagg)"},"levFundShort":{"type":["number","null"],"description":"Leveraged funds (tff); managed money (disagg)"},"otherLong":{"type":["number","null"],"description":"Other reportable positions"},"otherShort":{"type":["number","null"],"description":"Other reportable positions"},"nonreptLong":{"type":["number","null"],"description":"Non-reportable (small trader) positions"},"nonreptShort":{"type":["number","null"],"description":"Non-reportable (small trader) positions"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/cot/{slug}":{"get":{"summary":"One market's COT history","externalDocs":{"url":"https://xoomar.com/markets/api/cot"},"description":"Weekly reports, newest first; history starts in 2010 and the free API returns the last six months. Docs: https://xoomar.com/markets/api/cot","operationId":"cot_slug","tags":["Macro"],"parameters":[{"name":"slug","in":"path","required":true,"description":"Market slug from /api/markets/cot","schema":{"type":"string"},"example":"e-mini-s-p-500-stock-index"},{"name":"from","in":"query","required":false,"description":"First report date (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-01-01"},{"name":"to","in":"query","required":false,"description":"Last report date (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-01-01"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"reportDate":{"type":"string","format":"date","description":"CFTC report Tuesday, YYYY-MM-DD"},"openInterest":{"type":["number","null"],"description":"Total open interest in contracts"},"dealerLong":{"type":["number","null"],"description":"Dealers and intermediaries (tff); producers, merchants, processors and users (disagg)"},"dealerShort":{"type":["number","null"],"description":"Dealers and intermediaries (tff); producers, merchants, processors and users (disagg)"},"assetMgrLong":{"type":["number","null"],"description":"Asset managers and institutional investors (tff); swap dealers (disagg)"},"assetMgrShort":{"type":["number","null"],"description":"Asset managers and institutional investors (tff); swap dealers (disagg)"},"levFundLong":{"type":["number","null"],"description":"Leveraged funds (tff); managed money (disagg)"},"levFundShort":{"type":["number","null"],"description":"Leveraged funds (tff); managed money (disagg)"},"otherLong":{"type":["number","null"],"description":"Other reportable positions"},"otherShort":{"type":["number","null"],"description":"Other reportable positions"},"nonreptLong":{"type":["number","null"],"description":"Non-reportable (small trader) positions"},"nonreptShort":{"type":["number","null"],"description":"Non-reportable (small trader) positions"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/macro":{"get":{"summary":"US Treasury yield curve and stablecoin supply","externalDocs":{"url":"https://xoomar.com/markets/api/macro"},"description":"History starts in 1990 (stablecoins in 2017); the free API returns the last six months. Docs: https://xoomar.com/markets/api/macro","operationId":"macro","tags":["Macro"],"parameters":[{"name":"series","in":"query","required":false,"description":"yield-curve (default, daily), spreads (weekly 10y-2y and 10y-3m) or stablecoins (daily total supply, data by DefiLlama)","schema":{"type":"string","enum":["yield-curve","spreads","stablecoins"]}},{"name":"from","in":"query","required":false,"description":"First date (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-01-01"},{"name":"to","in":"query","required":false,"description":"Last date (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-01-01"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date","description":"Observation date, YYYY-MM-DD; yield-curve and stablecoins rows come newest first, spreads oldest first"},"m1...m6":{"type":["string","null"],"description":"1, 2, 3, 6 month Treasury yields in percent"},"y1...y30":{"type":["string","null"],"description":"1 to 30 year Treasury yields in percent"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/fed-liquidity":{"get":{"summary":"Fed net liquidity and its components","externalDocs":{"url":"https://xoomar.com/markets/api/fed-liquidity"},"description":"Docs: https://xoomar.com/markets/api/fed-liquidity","operationId":"fed_liquidity","tags":["Macro"],"parameters":[{"name":"series","in":"query","required":false,"description":"One series instead, by its id (WALCL, RRPONTSYD, WTREGEN, SOFR, IORB...)","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Rows returned, newest first inside the window (default 5000, max 10000)","schema":{"type":"integer"},"example":5000}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date","description":"H.4.1 Wednesday date"},"assets":{"type":"number","description":"Fed total assets, USD (WALCL)"},"tga":{"type":"number","description":"Treasury General Account, USD (WTREGEN)"},"rrp":{"type":"number","description":"Overnight reverse repo usage on that date, USD (RRPONTSYD)"},"reserves":{"type":["number","null"],"description":"Reserve balances with Federal Reserve Banks, USD (WRESBAL)"},"net":{"type":"number","description":"assets minus tga minus rrp, USD"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/treasury-auctions":{"get":{"summary":"US Treasury auction results and calendar since 2010","externalDocs":{"url":"https://xoomar.com/markets/api/treasury-auctions"},"description":"History starts in 2010; the free API returns the last six months. Docs: https://xoomar.com/markets/api/treasury-auctions","operationId":"treasury_auctions","tags":["Macro"],"parameters":[{"name":"type","in":"query","required":false,"description":"Security type (default: coupon auctions)","schema":{"type":"string","enum":["Note","Bond","TIPS","FRN","Bill","CMB","all"]}},{"name":"term","in":"query","required":false,"description":"One term","schema":{"type":"string"},"example":"10-Year"},{"name":"from","in":"query","required":false,"description":"First auction date (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-01-01"},{"name":"to","in":"query","required":false,"description":"Last auction date (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-01-01"},{"name":"upcoming","in":"query","required":false,"description":"Announced auctions not yet run, soonest first","schema":{"type":"boolean"}},{"name":"limit","in":"query","required":false,"description":"Rows returned, newest first inside the window (default 100, max 5000)","schema":{"type":"integer"},"example":100}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"cusip":{"type":"string","description":"Security CUSIP; a reopening shares the original's CUSIP"},"auctionDate":{"type":"string","format":"date","description":"Auction date"},"securityType":{"type":"string","description":"Bill, CMB (cash management bill), Note, Bond, TIPS or FRN"},"securityTerm":{"type":"string","description":"Term as announced: 4-Week, 2-Year, 10-Year, 9-Year 10-Month (reopening)"},"issueDate":{"type":["string","null"],"format":"date","description":"Settlement date"},"maturityDate":{"type":["string","null"],"format":"date","description":"Maturity"},"reopening":{"type":["boolean","null"],"description":"True when the auction adds to an existing issue"},"offeringAmount":{"type":["number","null"],"description":"Announced size, USD"},"totalAccepted":{"type":["number","null"],"description":"Accepted, USD (null until results)"},"totalTendered":{"type":["number","null"],"description":"Bids received, USD"},"highYield":{"type":["number","null"],"description":"Stop-out yield, percent (notes, bonds, TIPS)"},"highRate":{"type":["number","null"],"description":"High discount rate (bills) or high discount margin (FRNs), percent"},"interestRate":{"type":["number","null"],"description":"Coupon set at auction, percent"},"bidToCover":{"type":["number","null"],"description":"Tendered divided by accepted"},"indirectAccepted":{"type":["number","null"],"description":"Accepted from indirect bidders, USD"},"directAccepted":{"type":["number","null"],"description":"Accepted from direct bidders, USD"},"dealerAccepted":{"type":["number","null"],"description":"Accepted by primary dealers, USD"},"indirectShare":{"type":["number","null"],"description":"Indirect share of accepted, 0 to 1"},"directShare":{"type":["number","null"],"description":"Direct share of accepted, 0 to 1"},"dealerShare":{"type":["number","null"],"description":"Dealer share of accepted, 0 to 1"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/rates":{"get":{"summary":"Central bank policy rates, latest for 38 economies with a current series (49 in the archive)","externalDocs":{"url":"https://xoomar.com/markets/api/rates"},"description":"Docs: https://xoomar.com/markets/api/rates","operationId":"rates","tags":["Macro"],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"countryCode":{"type":"string","description":"BIS area code"},"country":{"type":"string","description":"Economy"},"date":{"type":"string","format":"date","description":"Observation date"},"rate":{"type":"string","description":"Policy rate, percent"},"lastChanged":{"type":["string","null"],"description":"Date of the most recent move"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/rates/{country}":{"get":{"summary":"One economy's policy rate history","externalDocs":{"url":"https://xoomar.com/markets/api/rates"},"description":"Daily history, newest first; history starts in 1945 and the free API returns the last six months. Docs: https://xoomar.com/markets/api/rates","operationId":"rates_country","tags":["Macro"],"parameters":[{"name":"country","in":"path","required":true,"description":"BIS area code: us, xm for the euro area, gb, jp and so on","schema":{"type":"string"},"example":"us"},{"name":"from","in":"query","required":false,"description":"First date (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-01-01"},{"name":"to","in":"query","required":false,"description":"Last date (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-01-01"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date","description":"Observation date"},"rate":{"type":"string","description":"Policy rate, percent"},"changed":{"type":"boolean","description":"True on days the rate moved"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}},"/api/markets/calendar":{"get":{"summary":"US economic calendar with actuals","externalDocs":{"url":"https://xoomar.com/markets/api/calendar"},"description":"nextReleaseAt in the envelope is when the next high-importance release is due. Send the ETag back in If-None-Match and an unchanged calendar answers 304 Not Modified with no body. Docs: https://xoomar.com/markets/api/calendar","operationId":"calendar","tags":["Macro"],"parameters":[{"name":"from","in":"query","required":false,"description":"First release date (default 7 days ago) (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-01-01"},{"name":"to","in":"query","required":false,"description":"Last release date (default 30 days ahead) (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-01-01"},{"name":"importance","in":"query","required":false,"description":"Importance filter","schema":{"type":"string","enum":["high","med","low"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string","description":"bls, bea, census, fed, dol or treasury (coupon auctions)"},"eventName":{"type":"string","description":"CPI (Consumer Price Index), Nonfarm Payrolls (Employment Situation), Initial Jobless Claims, Retail Sales (Advance), FOMC Rate Decision, ..."},"importance":{"type":"string","description":"high, med, or low"},"scheduledAt":{"type":"string","format":"date-time","description":"Release time, UTC"},"periodLabel":{"type":["string","null"],"description":"Reference period: 'August 2026', '3rd Quarter 2026', 'Week ending 2026-09-05'"},"previous":{"type":["string","null"],"description":"Prior period on the same basis as actual"},"forecast":{"type":["string","null"],"description":"Always null: consensus forecasts aren't included"},"actual":{"type":["string","null"],"description":"Filled after release from the agency series (CPI year over year %, payrolls monthly change in thousands, retail sales % m/m, claims in thousands, ...)"},"unit":{"type":["string","null"],"description":"What actual and previous are in: '% m/m', '% y/y, PCE price index', 'thousands, annual rate', 'USD billions, balance'"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"}}}},"updatedAt":{"type":"string","format":"date-time","description":"When the response was built; a few dated feeds give the date of their newest row instead"},"nextReleaseAt":{"type":["string","null"],"format":"date-time","description":"When the next high-importance release is due, UTC, whatever the window or filter asked for; null when none is scheduled"},"source":{"type":"string","const":"xoomar.com"},"docs":{"type":"string"},"license":{"type":"string","description":"Data terms"},"attribution":{"type":"string"},"canonicalUrl":{"type":"string","format":"uri","description":"The matching page on xoomar.com"},"meta":{"type":"object","description":"Who publishes the data and how to credit it","properties":{"source":{"type":"string","description":"The publisher or publishers of the data, comma-separated"},"sourceAttribution":{"type":"string","description":"The credit line to show wherever the data is displayed"},"notice":{"type":"string","description":"Requests without a key only: the free key, app registration and the credit"}}}}}}},"headers":{"ETag":{"schema":{"type":"string"},"description":"Send it back in If-None-Match: an unchanged response answers 304 Not Modified with no body"}}},"404":{"description":"Unknown slug, ticker or country","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"docs":{"type":"string"}}}}}},"429":{"description":"Rate limit: 10 requests a minute without a key, 30 with a free key","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}}}},"security":[{},{"apiKey":[]}]}}},"x-clients":{"python":"pip install xoomar","javascript":"npm install xoomar","mcp":"npx -y xoomar-mcp","mcpRemote":"https://xoomar.com/mcp","llms":"https://xoomar.com/llms.txt"}}