{"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:bybit/account-ratio":{"get":{"operationId":"finance_bybit_account_ratio","summary":"Long/Short Ratio","description":"Share of accounts holding long vs short positions.","tags":["finance"],"parameters":[{"name":"symbol","in":"query","required":true,"schema":{"type":"string"},"example":"BTCUSDT"},{"name":"category","in":"query","required":false,"schema":{"type":"string","enum":["linear","inverse"],"default":"linear"}},{"name":"period","in":"query","required":false,"schema":{"type":"string","enum":["5min","15min","30min","1h","4h","1d"],"default":"5min"}},{"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"}},{"name":"count","in":"query","required":false,"description":"Number of rows to return","schema":{"type":"integer","default":200,"minimum":1,"maximum":500,"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:bybit/funding-history":{"get":{"operationId":"finance_bybit_funding_history","summary":"Funding History","description":"Historical funding rates of a perpetual contract.","tags":["finance"],"parameters":[{"name":"symbol","in":"query","required":true,"schema":{"type":"string"},"example":"BTCUSDT"},{"name":"category","in":"query","required":false,"schema":{"type":"string","enum":["linear","inverse"],"default":"linear"}},{"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"}},{"name":"count","in":"query","required":false,"description":"Number of rows to return","schema":{"type":"integer","default":200,"minimum":1,"maximum":200,"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:bybit/index-price-kline":{"get":{"operationId":"finance_bybit_index_price_kline","summary":"Index Price Kline","description":"Index price candles.","tags":["finance"],"parameters":[{"name":"symbol","in":"query","required":true,"schema":{"type":"string"},"example":"BTCUSDT"},{"name":"category","in":"query","required":false,"schema":{"type":"string","enum":["linear","inverse"],"default":"linear"}},{"name":"interval","in":"query","required":false,"schema":{"type":"string","enum":["1","3","5","15","30","60","120","240","360","720","D","W","M"],"default":"5"}},{"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"}},{"name":"count","in":"query","required":false,"description":"Number of candles","schema":{"type":"integer","default":200,"minimum":1,"maximum":1000,"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:bybit/instruments-info":{"get":{"operationId":"finance_bybit_instruments_info","summary":"Instruments Info","description":"Contract and spot instrument specifications.","tags":["finance"],"parameters":[{"name":"category","in":"query","required":false,"schema":{"type":"string","enum":["linear","inverse","spot","option"],"default":"linear"}},{"name":"symbol","in":"query","required":false,"schema":{"type":"string"}},{"name":"baseCoin","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["Trading","PreLaunch","Delivering","Closed"]}},{"name":"count","in":"query","required":false,"description":"Number of rows to return","schema":{"type":"integer","default":500,"minimum":1,"maximum":1000,"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":3600,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:bybit/kline":{"get":{"operationId":"finance_bybit_kline","summary":"Kline","description":"OHLCV candles (newest first).","tags":["finance"],"parameters":[{"name":"symbol","in":"query","required":true,"schema":{"type":"string"},"example":"BTCUSDT"},{"name":"category","in":"query","required":false,"schema":{"type":"string","enum":["linear","inverse","spot"],"default":"linear"}},{"name":"interval","in":"query","required":false,"schema":{"type":"string","enum":["1","3","5","15","30","60","120","240","360","720","D","W","M"],"default":"5"}},{"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"}},{"name":"count","in":"query","required":false,"description":"Number of candles","schema":{"type":"integer","default":200,"minimum":1,"maximum":1000,"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:bybit/mark-price-kline":{"get":{"operationId":"finance_bybit_mark_price_kline","summary":"Mark Price Kline","description":"Mark price candles.","tags":["finance"],"parameters":[{"name":"symbol","in":"query","required":true,"schema":{"type":"string"},"example":"BTCUSDT"},{"name":"category","in":"query","required":false,"schema":{"type":"string","enum":["linear","inverse"],"default":"linear"}},{"name":"interval","in":"query","required":false,"schema":{"type":"string","enum":["1","3","5","15","30","60","120","240","360","720","D","W","M"],"default":"5"}},{"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"}},{"name":"count","in":"query","required":false,"description":"Number of candles","schema":{"type":"integer","default":200,"minimum":1,"maximum":1000,"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:bybit/open-interest":{"get":{"operationId":"finance_bybit_open_interest","summary":"Open Interest","description":"Open interest history of a contract.","tags":["finance"],"parameters":[{"name":"symbol","in":"query","required":true,"schema":{"type":"string"},"example":"BTCUSDT"},{"name":"category","in":"query","required":false,"schema":{"type":"string","enum":["linear","inverse"],"default":"linear"}},{"name":"intervalTime","in":"query","required":false,"schema":{"type":"string","enum":["5min","15min","30min","1h","4h","1d"],"default":"5min"}},{"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"}},{"name":"count","in":"query","required":false,"description":"Number of rows to return","schema":{"type":"integer","default":200,"minimum":1,"maximum":200,"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":120,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:bybit/orderbook":{"get":{"operationId":"finance_bybit_orderbook","summary":"Orderbook","description":"Bids and asks for a symbol.","tags":["finance"],"parameters":[{"name":"symbol","in":"query","required":true,"schema":{"type":"string"},"example":"BTCUSDT"},{"name":"category","in":"query","required":false,"schema":{"type":"string","enum":["linear","inverse","spot","option"],"default":"linear"}},{"name":"count","in":"query","required":false,"description":"Depth per side","schema":{"type":"integer","default":50,"minimum":1,"maximum":1000,"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:bybit/premium-index-kline":{"get":{"operationId":"finance_bybit_premium_index_kline","summary":"Premium Index Kline","description":"Premium index candles for perpetuals.","tags":["finance"],"parameters":[{"name":"symbol","in":"query","required":true,"schema":{"type":"string"},"example":"BTCUSDT"},{"name":"category","in":"query","required":false,"schema":{"type":"string","enum":["linear"],"default":"linear"}},{"name":"interval","in":"query","required":false,"schema":{"type":"string","enum":["1","3","5","15","30","60","120","240","360","720","D","W","M"],"default":"5"}},{"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"}},{"name":"count","in":"query","required":false,"description":"Number of candles","schema":{"type":"integer","default":200,"minimum":1,"maximum":1000,"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:bybit/recent-trade":{"get":{"operationId":"finance_bybit_recent_trade","summary":"Recent Trade","description":"Most recent public trades.","tags":["finance"],"parameters":[{"name":"symbol","in":"query","required":true,"schema":{"type":"string"},"example":"BTCUSDT"},{"name":"category","in":"query","required":false,"schema":{"type":"string","enum":["linear","inverse","spot","option"],"default":"linear"}},{"name":"baseCoin","in":"query","required":false,"schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"Number of rows to return","schema":{"type":"integer","default":100,"minimum":1,"maximum":1000,"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"}},"/v1/finance:bybit/tickers":{"get":{"operationId":"finance_bybit_tickers","summary":"Tickers","description":"Latest price, 24h stats, funding and open interest.","tags":["finance"],"parameters":[{"name":"category","in":"query","required":false,"schema":{"type":"string","enum":["linear","inverse","spot","option"],"default":"linear"}},{"name":"symbol","in":"query","required":false,"schema":{"type":"string"}},{"name":"baseCoin","in":"query","required":false,"schema":{"type":"string"}},{"name":"expDate","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"}}},"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"}}}}}}}