{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/finance:okx/books":{"get":{"operationId":"finance_okx_books","summary":"Order Book","description":"Bids and asks for one instrument.","tags":["finance"],"parameters":[{"name":"symbol","in":"query","required":true,"description":"OKX instrument id (instId)","schema":{"type":"string","description":"OKX instrument id (instId)"},"example":"BTC-USDT-SWAP"},{"name":"count","in":"query","required":false,"description":"Depth per side","schema":{"type":"integer","default":20,"minimum":1,"maximum":400,"description":"Depth per side"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":5,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:okx/candles":{"get":{"operationId":"finance_okx_candles","summary":"Candles","description":"Recent OHLCV candles for an instrument.","tags":["finance"],"parameters":[{"name":"symbol","in":"query","required":true,"description":"OKX instrument id (instId)","schema":{"type":"string","description":"OKX instrument id (instId)"},"example":"BTC-USDT-SWAP"},{"name":"bar","in":"query","required":false,"schema":{"type":"string","enum":["1m","3m","5m","15m","30m","1H","2H","4H","6H","12H","1D","2D","3D","1W","1M","3M","6Hutc","12Hutc","1Dutc","2Dutc","3Dutc","1Wutc","1Mutc","3Mutc"],"default":"5m"}},{"name":"end","in":"query","required":false,"description":"Return candles older than this time (epoch ms or ISO)","schema":{"type":"string","description":"Return candles older than this time (epoch ms or ISO)"}},{"name":"count","in":"query","required":false,"description":"Number of candles","schema":{"type":"integer","default":100,"minimum":1,"maximum":300,"description":"Number of candles"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"minimum":1,"maximum":1}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":30,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:okx/funding-rate-history":{"get":{"operationId":"finance_okx_funding_rate_history","summary":"Funding Rate History","description":"Past funding rates of a perpetual swap.","tags":["finance"],"parameters":[{"name":"symbol","in":"query","required":true,"description":"OKX instrument id (instId)","schema":{"type":"string","description":"OKX instrument id (instId)"},"example":"BTC-USDT-SWAP"},{"name":"end","in":"query","required":false,"description":"Older than this time","schema":{"type":"string","description":"Older than this time"}},{"name":"count","in":"query","required":false,"description":"Number of rows to return","schema":{"type":"integer","default":100,"minimum":1,"maximum":400,"description":"Number of rows to return"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"minimum":1,"maximum":1}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":300,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:okx/funding-rate":{"get":{"operationId":"finance_okx_funding_rate","summary":"Funding Rate","description":"Current and next funding rate of a perpetual swap.","tags":["finance"],"parameters":[{"name":"symbol","in":"query","required":true,"description":"OKX instrument id (instId)","schema":{"type":"string","description":"OKX instrument id (instId)"},"example":"BTC-USDT-SWAP"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":30,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:okx/history-candles":{"get":{"operationId":"finance_okx_history_candles","summary":"History Candles","description":"Older OHLCV candles going back years.","tags":["finance"],"parameters":[{"name":"symbol","in":"query","required":true,"description":"OKX instrument id (instId)","schema":{"type":"string","description":"OKX instrument id (instId)"},"example":"BTC-USDT-SWAP"},{"name":"bar","in":"query","required":false,"schema":{"type":"string","enum":["1m","3m","5m","15m","30m","1H","2H","4H","6H","12H","1D","2D","3D","1W","1M","3M","6Hutc","12Hutc","1Dutc","2Dutc","3Dutc","1Wutc","1Mutc","3Mutc"],"default":"5m"}},{"name":"end","in":"query","required":false,"description":"Return candles older than this time (epoch ms or ISO)","schema":{"type":"string","description":"Return candles older than this time (epoch ms or ISO)"}},{"name":"count","in":"query","required":false,"description":"Number of candles","schema":{"type":"integer","default":100,"minimum":1,"maximum":100,"description":"Number of candles"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"minimum":1,"maximum":1}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":30,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:okx/instruments":{"get":{"operationId":"finance_okx_instruments","summary":"Instruments","description":"Instrument specifications (tick size, lot size, contract value…).","tags":["finance"],"parameters":[{"name":"instType","in":"query","required":false,"schema":{"type":"string","enum":["SPOT","MARGIN","SWAP","FUTURES","OPTION"],"default":"SWAP"}},{"name":"symbol","in":"query","required":false,"schema":{"type":"string"}},{"name":"instFamily","in":"query","required":false,"schema":{"type":"string"}},{"name":"uly","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":3600,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:okx/long-short-ratio":{"get":{"operationId":"finance_okx_long_short_ratio","summary":"Long/Short Account Ratio","description":"Ratio of accounts net long vs net short on contracts.","tags":["finance"],"parameters":[{"name":"currency","in":"query","required":false,"schema":{"type":"string","default":"BTC"}},{"name":"period","in":"query","required":false,"schema":{"type":"string","enum":["5m","1H","1D"],"default":"5m"}},{"name":"start","in":"query","required":false,"description":"Epoch ms or ISO date","schema":{"type":"string","description":"Epoch ms or ISO date"}},{"name":"end","in":"query","required":false,"description":"Epoch ms or ISO date","schema":{"type":"string","description":"Epoch ms or ISO date"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":300,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:okx/mark-price":{"get":{"operationId":"finance_okx_mark_price","summary":"Mark Price","description":"Mark prices used for margin and liquidation.","tags":["finance"],"parameters":[{"name":"instType","in":"query","required":false,"schema":{"type":"string","enum":["MARGIN","SWAP","FUTURES","OPTION"],"default":"SWAP"}},{"name":"symbol","in":"query","required":false,"schema":{"type":"string"}},{"name":"instFamily","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":10,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:okx/open-interest-volume":{"get":{"operationId":"finance_okx_open_interest_volume","summary":"Open Interest & Volume","description":"Aggregate contract open interest and trading volume over time.","tags":["finance"],"parameters":[{"name":"currency","in":"query","required":false,"schema":{"type":"string","default":"BTC"}},{"name":"period","in":"query","required":false,"schema":{"type":"string","enum":["5m","1H","1D"],"default":"5m"}},{"name":"start","in":"query","required":false,"description":"Epoch ms or ISO date","schema":{"type":"string","description":"Epoch ms or ISO date"}},{"name":"end","in":"query","required":false,"description":"Epoch ms or ISO date","schema":{"type":"string","description":"Epoch ms or ISO date"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":300,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:okx/open-interest":{"get":{"operationId":"finance_okx_open_interest","summary":"Open Interest","description":"Open interest per derivative instrument.","tags":["finance"],"parameters":[{"name":"instType","in":"query","required":false,"schema":{"type":"string","enum":["SWAP","FUTURES","OPTION"],"default":"SWAP"}},{"name":"symbol","in":"query","required":false,"schema":{"type":"string"}},{"name":"instFamily","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":30,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:okx/price-limit":{"get":{"operationId":"finance_okx_price_limit","summary":"Price Limit","description":"Highest buy and lowest sell price currently allowed.","tags":["finance"],"parameters":[{"name":"symbol","in":"query","required":true,"description":"OKX instrument id (instId)","schema":{"type":"string","description":"OKX instrument id (instId)"},"example":"BTC-USDT-SWAP"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":10,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:okx/taker-volume":{"get":{"operationId":"finance_okx_taker_volume","summary":"Taker Volume","description":"Taker buy vs sell volume over time.","tags":["finance"],"parameters":[{"name":"currency","in":"query","required":false,"schema":{"type":"string","default":"BTC"}},{"name":"instType","in":"query","required":false,"schema":{"type":"string","enum":["SPOT","CONTRACTS"],"default":"CONTRACTS"}},{"name":"period","in":"query","required":false,"schema":{"type":"string","enum":["5m","1H","1D"],"default":"5m"}},{"name":"start","in":"query","required":false,"description":"Epoch ms or ISO date","schema":{"type":"string","description":"Epoch ms or ISO date"}},{"name":"end","in":"query","required":false,"description":"Epoch ms or ISO date","schema":{"type":"string","description":"Epoch ms or ISO date"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":300,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:okx/ticker":{"get":{"operationId":"finance_okx_ticker","summary":"Ticker","description":"Latest price and 24h stats for one instrument.","tags":["finance"],"parameters":[{"name":"symbol","in":"query","required":true,"description":"OKX instrument id (instId)","schema":{"type":"string","description":"OKX instrument id (instId)"},"example":"BTC-USDT-SWAP"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":10,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:okx/tickers":{"get":{"operationId":"finance_okx_tickers","summary":"Tickers","description":"Tickers for every instrument of a type.","tags":["finance"],"parameters":[{"name":"instType","in":"query","required":false,"schema":{"type":"string","enum":["SPOT","MARGIN","SWAP","FUTURES","OPTION"],"default":"SWAP"}},{"name":"instFamily","in":"query","required":false,"schema":{"type":"string"}},{"name":"uly","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":15,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:okx/trades":{"get":{"operationId":"finance_okx_trades","summary":"Trades","description":"Most recent trades for an instrument.","tags":["finance"],"parameters":[{"name":"symbol","in":"query","required":true,"description":"OKX instrument id (instId)","schema":{"type":"string","description":"OKX instrument id (instId)"},"example":"BTC-USDT-SWAP"},{"name":"count","in":"query","required":false,"description":"Number of rows to return","schema":{"type":"integer","default":100,"minimum":1,"maximum":500,"description":"Number of rows to return"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":5,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}