openapi.json

{"openapi":"3.0.2","info":{"title":"Crypto Exchange Demo","version":"0.1.0","description":"username: test10000 .. test20000, password: 123456"},"paths":{"/symbols":{"get":{"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response_Symbols_Symbols_Get","type":"array","items":{"$ref":"#/components/schemas/Symbol"}}}}}},"tags":["public"],"summary":"Symbols","description":"获取币对列表","operationId":"symbols_symbols_get"}},"/kline/{symbol}/{interval}":{"get":{"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response_Kline_Kline__Symbol___Interval__Get","type":"array","items":{"$ref":"#/components/schemas/Kline"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["public"],"summary":"Kline","description":"查询K线","operationId":"kline_kline__symbol___interval__get","parameters":[{"required":true,"schema":{"title":"Symbol","type":"string"},"name":"symbol","in":"path"},{"required":true,"schema":{"title":"Interval","enum":["1m","3m","5m","15m","30m","1h","2h","3h","6h","12h","1d","1w","1mo"],"type":"string"},"name":"interval","in":"path"},{"required":false,"schema":{"title":"Start","type":"integer","default":0},"name":"start","in":"query"},{"required":false,"schema":{"title":"End","type":"integer","default":253370764800000},"name":"end","in":"query"},{"required":false,"schema":{"title":"Count","type":"integer","default":1000},"name":"count","in":"query"}]}},"/depth/{symbol}":{"get":{"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Depth"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["public"],"summary":"Depth","description":"查询深度","operationId":"depth_depth__symbol__get","parameters":[{"required":true,"schema":{"title":"Symbol","type":"string"},"name":"symbol","in":"path"},{"required":false,"schema":{"title":"Count","type":"integer","default":500},"name":"count","in":"query"}]}},"/aggtrade/{symbol}":{"get":{"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response_Aggtrade_Aggtrade__Symbol__Get","type":"array","items":{"$ref":"#/components/schemas/Trade"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["public"],"summary":"Aggtrade","description":"查询最近成交列表","operationId":"aggtrade_aggtrade__symbol__get","parameters":[{"required":true,"schema":{"title":"Symbol","type":"string"},"name":"symbol","in":"path"},{"required":false,"schema":{"title":"Count","type":"integer","default":100},"name":"count","in":"query"}]}},"/limit/{symbol}":{"post":{"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimpleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["authenticated"],"summary":"Limit","description":"限价下单","operationId":"limit_limit__symbol__post","parameters":[{"required":true,"schema":{"title":"Symbol","type":"string"},"name":"symbol","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitOrderRequest"}}},"required":true},"security":[{"OAuth2PasswordBearer":[]}]}},"/cancel/{symbol}":{"post":{"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimpleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["authenticated"],"summary":"Cancel","description":"撤单","operationId":"cancel_cancel__symbol__post","parameters":[{"required":true,"schema":{"title":"Symbol","type":"string"},"name":"symbol","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelRequest"}}},"required":true}}},"/open_orders":{"get":{"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response_Open_Orders_Open_Orders_Get","type":"array","items":{"$ref":"#/components/schemas/Order"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["authenticated"],"summary":"Open Orders","description":"查询委托中订单","operationId":"open_orders_open_orders_get","parameters":[{"required":false,"schema":{"title":"Symbol","type":"string"},"name":"symbol","in":"query"},{"required":false,"schema":{"title":"Offset","type":"integer","default":0},"name":"offset","in":"query"}],"security":[{"OAuth2PasswordBearer":[]}]}},"/history_orders":{"get":{"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response_History_Orders_History_Orders_Get","type":"array","items":{"$ref":"#/components/schemas/Order"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["authenticated"],"summary":"History Orders","description":"查询历史订单","operationId":"history_orders_history_orders_get","parameters":[{"required":false,"schema":{"title":"Symbol","type":"string"},"name":"symbol","in":"query"},{"required":false,"schema":{"title":"Offset","type":"integer","default":0},"name":"offset","in":"query"}],"security":[{"OAuth2PasswordBearer":[]}]}},"/trade_record":{"get":{"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response_Trade_Record_Trade_Record_Get","type":"array","items":{"$ref":"#/components/schemas/TradeRecord"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["authenticated"],"summary":"Trade Record","operationId":"trade_record_trade_record_get","parameters":[{"required":false,"schema":{"title":"Symbol","type":"string"},"name":"symbol","in":"query"},{"required":false,"schema":{"title":"Offset","type":"integer","default":0},"name":"offset","in":"query"}],"security":[{"OAuth2PasswordBearer":[]}]}},"/assets":{"get":{"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response_User_Assets_Assets_Get","type":"array","items":{"$ref":"#/components/schemas/UserAssets"}}}}}},"tags":["authenticated"],"summary":"User Assets","description":"查询用户资产余额","operationId":"user_assets_assets_get","security":[{"OAuth2PasswordBearer":[]}]}},"/user_stream":{"post":{"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimpleResponse"}}}}},"tags":["authenticated"],"summary":"User Stream","description":"获取用户私有websocket流token，详情见websocket api文档","operationId":"user_stream_user_stream_post","security":[{"OAuth2PasswordBearer":[]}]}},"/simulate_asset":{"post":{"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimpleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["debug"],"summary":"Simulate Asset","description":"模拟资金充值提现操作","operationId":"simulate_asset_simulate_asset_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetSimulateRequest"}}},"required":true},"security":[{"OAuth2PasswordBearer":[]}]}},"/token":{"post":{"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["auth"],"summary":"Login","operationId":"login_token_post","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/Body_login_token_post"}}},"required":true}}},"/users/me":{"get":{"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"tags":["auth"],"summary":"Get Me Info","operationId":"get_me_info_users_me_get","security":[{"OAuth2PasswordBearer":[]}]}}},"components":{"schemas":{"CancelRequest":{"title":"CancelRequest","required":["order_id"],"type":"object","properties":{"order_id":{"title":"Order_Id","type":"string"}}},"Trade":{"title":"Trade","required":["taker_id","side","price","amount"],"type":"object","properties":{"taker_id":{"title":"Taker_Id","type":"string"},"side":{"title":"Side","enum":["buy","sell"],"type":"string"},"price":{"title":"Price","type":"number"},"amount":{"title":"Amount","type":"number"}}},"LimitOrderRequest":{"title":"LimitOrderRequest","required":["side","price","amount"],"type":"object","properties":{"side":{"title":"Side","enum":["buy","sell"],"type":"string"},"price":{"title":"Price","type":"number"},"amount":{"title":"Amount","type":"number"}}},"AssetSimulateRequest":{"title":"AssetSimulateRequest","required":["coin","operation","amount","txid"],"type":"object","properties":{"coin":{"title":"Coin","type":"string"},"operation":{"title":"Operation","enum":["deposit","redeem"],"type":"string"},"amount":{"title":"Amount","type":"number"},"txid":{"title":"Txid","type":"string"}}},"Order":{"title":"Order","required":["id","side","user_id","price","amount","avail_amount","deal_value","taker_fee_rate","maker_fee_rate","done","update_id","symbol","time"],"type":"object","properties":{"id":{"title":"Id","type":"string"},"side":{"title":"Side","enum":["buy","sell"],"type":"string"},"user_id":{"title":"User_Id","type":"integer"},"price":{"title":"Price","type":"number"},"amount":{"title":"Amount","type":"number"},"avail_amount":{"title":"Avail_Amount","type":"number"},"deal_value":{"title":"Deal_Value","type":"number"},"taker_fee_rate":{"title":"Taker_Fee_Rate","type":"number"},"maker_fee_rate":{"title":"Maker_Fee_Rate","type":"number"},"done":{"title":"Done","type":"boolean"},"update_id":{"title":"Update_Id","type":"integer"},"symbol":{"title":"Symbol","type":"string"},"time":{"title":"Time","type":"string","format":"date-time"}}},"Body_login_token_post":{"title":"Body_login_token_post","required":["username","password"],"type":"object","properties":{"grant_type":{"title":"Grant_Type","pattern":"password","type":"string"},"username":{"title":"Username","type":"string"},"password":{"title":"Password","type":"string"},"scope":{"title":"Scope","type":"string","default":""},"client_id":{"title":"Client_Id","type":"string"},"client_secret":{"title":"Client_Secret","type":"string"}}},"TradeRecord":{"title":"TradeRecord","required":["id","taker_id","user_id","side","price","amount","fee","time","symbol_id"],"type":"object","properties":{"id":{"title":"Id","type":"integer"},"taker_id":{"title":"Taker_Id","type":"string"},"user_id":{"title":"User_Id","type":"integer"},"side":{"title":"Side","enum":["buy","sell"],"type":"string"},"price":{"title":"Price","type":"number"},"amount":{"title":"Amount","type":"number"},"fee":{"title":"Fee","type":"number"},"time":{"title":"Time","type":"string","format":"date-time"},"symbol_id":{"title":"Symbol_Id","type":"integer"}}},"Depth":{"title":"Depth","required":["update_id","asks","bids"],"type":"object","properties":{"update_id":{"title":"Update_Id","type":"integer"},"asks":{"title":"Asks","type":"array","items":{"type":"array","items":[{"type":"number"},{"type":"number"}]}},"bids":{"title":"Bids","type":"array","items":{"type":"array","items":[{"type":"number"},{"type":"number"}]}}}},"UserAssets":{"title":"UserAssets","required":["coin","amount","order_locked","withdraw_locked"],"type":"object","properties":{"coin":{"title":"Coin","type":"string"},"amount":{"title":"Amount","type":"number"},"order_locked":{"title":"Order_Locked","type":"number"},"withdraw_locked":{"title":"Withdraw_Locked","type":"number"}}},"Symbol":{"title":"Symbol","required":["id","name","price_unit","amount_unit","min_amount","taker_fee","maker_fee"],"type":"object","properties":{"id":{"title":"Id","type":"integer"},"name":{"title":"Name","type":"string"},"price_unit":{"title":"Price_Unit","type":"number"},"amount_unit":{"title":"Amount_Unit","type":"number"},"min_amount":{"title":"Min_Amount","type":"number"},"taker_fee":{"title":"Taker_Fee","type":"number"},"maker_fee":{"title":"Maker_Fee","type":"number"}}},"SimpleResponse":{"title":"SimpleResponse","required":["id"],"type":"object","properties":{"id":{"title":"Id","type":"string"}}},"Kline":{"title":"Kline","required":["time","open","high","low","close","volume","value"],"type":"object","properties":{"time":{"title":"Time","type":"integer"},"open":{"title":"Open","type":"number"},"high":{"title":"High","type":"number"},"low":{"title":"Low","type":"number"},"close":{"title":"Close","type":"number"},"volume":{"title":"Volume","type":"number"},"value":{"title":"Value","type":"number"}}},"ValidationError":{"title":"ValidationError","required":["loc","msg","type"],"type":"object","properties":{"loc":{"title":"Location","type":"array","items":{"type":"string"}},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}}},"HTTPValidationError":{"title":"HTTPValidationError","type":"object","properties":{"detail":{"title":"Detail","type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}}}},"securitySchemes":{"OAuth2PasswordBearer":{"type":"oauth2","flows":{"password":{"scopes":{},"tokenUrl":"/token"}}}}}}