{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"API Overview","description":"The first provable exchange","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"api-overview"},"children":["API Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is our API documentation."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Hibachi provides 2 types of API:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["REST API"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Websocket API"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The REST API provides all functionality access with easy-to-use request and response models."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Websocket API provides lower latency access to real time trading and data."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"documentation"},"children":["Documentation"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["View ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/api/definitions"},"children":["Key Definitions"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["View ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/api/prerequisites"},"children":["Pre-requisites"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"rest-api"},"children":["REST API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can find documentation for all Hibachi REST API on this page."]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":5,"id":"we-have-2-different-categories-of-api"},"children":["We have 2 different categories of API:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Account API: for account specific query and action"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Market API: for market data and metadata"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"websocket-api"},"children":["Websocket API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For Websocket API, please use this ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://www.postman.com/hibachi-xyz/hibachi-public/collection/6707f03b7c82ad6d2f10477c"},"children":["link"]}," to access our public Postman workspace."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can find the detailed documentation this way:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select \"Websockets API\" and choose one of the API endpoint."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click the \"Documentation\" button on top right."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"quick-links"},"children":["Quick Links"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Hibachi UI: ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://hibachi.xyz"},"children":["https://hibachi.xyz"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://api-doc.hibachi.xyz/#183981da-8df5-40a0-a155-da15015dd536"},"children":["Exchange Info API"]}," to get the list of future contracts"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://api-doc.hibachi.xyz/#00f6d5ad-5275-41cb-a1a8-19ed5d142124"},"children":["Trade Order API"]}," to place orders"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://api-doc.hibachi.xyz/#69aafedb-8274-4e21-bbaf-91dace8b8f31"},"children":["Account Info API"]}," to get account status"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"authorization"},"children":["Authorization"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This folder is using API Key from folder ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://api-doc.hibachi.xyz/#auth-info-fd6291b1-bd66-43a7-a3d5-833e4661954b"},"children":["Account API"]}]}]},"headings":[{"value":"API Overview","id":"api-overview","depth":1},{"value":"Documentation","id":"documentation","depth":1},{"value":"REST API","id":"rest-api","depth":1},{"value":"We have 2 different categories of API:","id":"we-have-2-different-categories-of-api","depth":5},{"value":"Websocket API","id":"websocket-api","depth":1},{"value":"Quick Links","id":"quick-links","depth":1},{"value":"Authorization","id":"authorization","depth":1}],"frontmatter":{"seo":{"title":"API Overview"}},"lastModified":"2025-04-15T10:57:42.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/api","userData":{"isAuthenticated":false,"teams":["anonymous"]}}