
<!doctype html>
<html lang="en" class="no-js">
  <head>
    
      <meta charset="utf-8">
      <meta name="viewport" content="width=device-width,initial-scale=1">
      
      
      
      
      
      
        
          <link rel="alternate" href="./" hreflang="en">
        
          <link rel="alternate" href="../../zh/futures/general-info/" hreflang="zh">
        
      
      
      <link rel="icon" href="../../assets/favicon.png">
      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.1">
    
    
      
        <title>General info - Aster API Docs</title>
      
    
    
      <link rel="stylesheet" href="../../assets/stylesheets/main.484c7ddc.min.css">
      
        
        <link rel="stylesheet" href="../../assets/stylesheets/palette.ab4e12ef.min.css">
      
      


    
    
      
    
    
      
        
        
        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
        <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
      
    
    
      <link rel="stylesheet" href="../../stylesheets/extra.css">
    
    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
    
      

    
    
  </head>
  
  
    
    
      
    
    
    
    
    <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
  
    
    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
    <label class="md-overlay" for="__drawer"></label>
    <div data-md-component="skip">
      
        
        <a href="#general-api-information" class="md-skip">
          Skip to content
        </a>
      
    </div>
    <div data-md-component="announce">
      
    </div>
    
    
      

  

<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
  <nav class="md-header__inner md-grid" aria-label="Header">
    <a href="../.." title="Aster API Docs" class="md-header__button md-logo" aria-label="Aster API Docs" data-md-component="logo">
      
  <img src="../../assets/logo.svg" alt="logo">

    </a>
    <label class="md-header__button md-icon" for="__drawer">
      
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
    </label>
    <div class="md-header__title" data-md-component="header-title">
      <div class="md-header__ellipsis">
        <div class="md-header__topic">
          <span class="md-ellipsis">
            Aster API Docs
          </span>
        </div>
        <div class="md-header__topic" data-md-component="header-topic">
          <span class="md-ellipsis">
            
              General info
            
          </span>
        </div>
      </div>
    </div>
    
      
        <form class="md-header__option" data-md-component="palette">
  
    
    
    
    <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo"  aria-label="Switch to dark mode"  type="radio" name="__palette" id="__palette_0">
    
      <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3zm3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95zm-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31"/></svg>
      </label>
    
  
    
    
    
    <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo"  aria-label="Switch to light mode"  type="radio" name="__palette" id="__palette_1">
    
      <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5s-1.65.15-2.39.42zM3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29zm.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14zM20.65 7l-1.77 3.79a7.02 7.02 0 0 0-2.38-4.15zm-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29zM12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44z"/></svg>
      </label>
    
  
</form>
      
    
    
      <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
    
    
      <div class="md-header__option">
  <div class="md-select">
    
    <button class="md-header__button md-icon" aria-label="Select language">
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12.87 15.07-2.54-2.51.03-.03A17.5 17.5 0 0 0 14.07 6H17V4h-7V2H8v2H1v2h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2zm-2.62 7 1.62-4.33L19.12 17z"/></svg>
    </button>
    <div class="md-select__inner">
      <ul class="md-select__list">
        
          <li class="md-select__item">
            <a href="./" hreflang="en" class="md-select__link">
              English
            </a>
          </li>
        
          <li class="md-select__item">
            <a href="../../zh/futures/general-info/" hreflang="zh" class="md-select__link">
              中文
            </a>
          </li>
        
      </ul>
    </div>
  </div>
</div>
    
    
      
      
        <label class="md-header__button md-icon" for="__search">
          
          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
        </label>
        <div class="md-search" data-md-component="search" role="dialog">
  <label class="md-search__overlay" for="__search"></label>
  <div class="md-search__inner" role="search">
    <form class="md-search__form" name="search">
      <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
      <label class="md-search__icon md-icon" for="__search">
        
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
        
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
      </label>
      <nav class="md-search__options" aria-label="Search">
        
        <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
          
          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
        </button>
      </nav>
      
        <div class="md-search__suggest" data-md-component="search-suggest"></div>
      
    </form>
    <div class="md-search__output">
      <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
        <div class="md-search-result" data-md-component="search-result">
          <div class="md-search-result__meta">
            Initializing search
          </div>
          <ol class="md-search-result__list" role="presentation"></ol>
        </div>
      </div>
    </div>
  </div>
</div>
      
    
    
  </nav>
  
    
      
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  <div class="md-grid">
    <ul class="md-tabs__list">
      
        
  
  
  
  
    
    
      <li class="md-tabs__item">
        <a href="../../futures-v3/general-info/" class="md-tabs__link">
          
  
  
  Futures v3

        </a>
      </li>
    
  

      
        
  
  
  
  
    
    
      <li class="md-tabs__item">
        <a href="../../spot-v3/general-info/" class="md-tabs__link">
          
  
  
  Spot V3

        </a>
      </li>
    
  

      
        
  
  
  
  
    
    
      <li class="md-tabs__item">
        <a href="../../asterCode/integration-flow/" class="md-tabs__link">
          
  
  
  Aster Code

        </a>
      </li>
    
  

      
        
  
  
  
  
    
    
      <li class="md-tabs__item">
        <a href="../../rpc/general-info/" class="md-tabs__link">
          
  
  
  RPC

        </a>
      </li>
    
  

      
        
  
  
  
  
    
    
      <li class="md-tabs__item">
        <a href="../../aster-chain/endpoints/" class="md-tabs__link">
          
  
  
  Aster Chain

        </a>
      </li>
    
  

      
        
  
  
  
  
    
    
      <li class="md-tabs__item">
        <a href="../../bapi/announcement/" class="md-tabs__link">
          
  
  
  BAPI

        </a>
      </li>
    
  

      
        
  
  
  
  
    
    
      <li class="md-tabs__item">
        <a href="../../futures-testnet/general-info/" class="md-tabs__link">
          
  
  
  Futures Testnet

        </a>
      </li>
    
  

      
        
  
  
  
  
    
    
      <li class="md-tabs__item">
        <a href="../../spot-testnet/general-info/" class="md-tabs__link">
          
  
  
  Spot Testnet

        </a>
      </li>
    
  

      
        
  
  
  
  
    
    
      <li class="md-tabs__item">
        <a href="../../prediction-testnet/general-info/" class="md-tabs__link">
          
  
  
  Prediction Testnet

        </a>
      </li>
    
  

      
        
  
  
  
  
    <li class="md-tabs__item">
      <a href="../../demo/demo/" class="md-tabs__link">
        
  
  
    
  
  Demo

      </a>
    </li>
  

      
        
  
  
  
  
    
    
      <li class="md-tabs__item">
        <a href="../../changelog/upcoming-changes/" class="md-tabs__link">
          
  
  
  Changelog

        </a>
      </li>
    
  

      
    </ul>
  </div>
</nav>
    
  
</header>
    
    <div class="md-container" data-md-component="container">
      
      
        
      
      <main class="md-main" data-md-component="main">
        <div class="md-main__inner md-grid">
          
            
              
              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
                <div class="md-sidebar__scrollwrap">
                  <div class="md-sidebar__inner">
                    


  


<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  <label class="md-nav__title" for="__drawer">
    <a href="../.." title="Aster API Docs" class="md-nav__button md-logo" aria-label="Aster API Docs" data-md-component="logo">
      
  <img src="../../assets/logo.svg" alt="logo">

    </a>
    Aster API Docs
  </label>
  
  <ul class="md-nav__list" data-md-scrollfix>
    
      
      
  
  
  
  
    
    
    
    
      
      
        
      
    
    
    <li class="md-nav__item md-nav__item--nested">
      
        
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1" >
        
          
          <label class="md-nav__link" for="__nav_1" id="__nav_1_label" tabindex="0">
            
  
  
  <span class="md-ellipsis">
    
  
    Futures v3
  

    
  </span>
  
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_1">
            <span class="md-nav__icon md-icon"></span>
            
  
    Futures v3
  

          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../futures-v3/general-info/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    General Info
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../futures-v3/market-data/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    Market Data
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../futures-v3/account%26trades/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    Futures Account & Trading
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../futures-v3/websocket-market-streams/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    WebSocket Market Data
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../futures-v3/user-data-streams/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    WebSocket Account Info
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../futures-v3/deposit%26withdrawal/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    Deposit & Withdrawal
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../futures-v3/error-codes/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    Error Codes
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
          </ul>
        </nav>
      
    </li>
  

    
      
      
  
  
  
  
    
    
    
    
      
      
        
      
    
    
    <li class="md-nav__item md-nav__item--nested">
      
        
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
        
          
          <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
            
  
  
  <span class="md-ellipsis">
    
  
    Spot V3
  

    
  </span>
  
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_2">
            <span class="md-nav__icon md-icon"></span>
            
  
    Spot V3
  

          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../spot-v3/general-info/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    General Info
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../spot-v3/market-data/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    Market Data
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../spot-v3/account%26trades/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    Spot Account & Trading
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../spot-v3/websocket-market-streams/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    WebSocket Market Data
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../spot-v3/websocket-account-info/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    WebSocket Account Info
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
          </ul>
        </nav>
      
    </li>
  

    
      
      
  
  
  
  
    
    
    
    
      
      
        
      
    
    
    <li class="md-nav__item md-nav__item--nested">
      
        
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
        
          
          <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
            
  
  
  <span class="md-ellipsis">
    
  
    Aster Code
  

    
  </span>
  
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_3">
            <span class="md-nav__icon md-icon"></span>
            
  
    Aster Code
  

          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../asterCode/integration-flow/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    Futures Integration Flow
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../asterCode/authentication/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    Futures Authentication
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../asterCode/endpoints/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    Futures Endpoints
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../asterCode/spot-integration-flow/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    Spot Integration Flow
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../asterCode/spot-authentication/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    Spot Authentication
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../asterCode/spot-endpoints/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    Spot Endpoints
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
          </ul>
        </nav>
      
    </li>
  

    
      
      
  
  
  
  
    
    
    
    
      
      
        
      
    
    
    <li class="md-nav__item md-nav__item--nested">
      
        
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
        
          
          <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
            
  
  
  <span class="md-ellipsis">
    
  
    RPC
  

    
  </span>
  
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_4">
            <span class="md-nav__icon md-icon"></span>
            
  
    RPC
  

          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../rpc/general-info/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    General Info
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../rpc/endpoints/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    Endpoints
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
          </ul>
        </nav>
      
    </li>
  

    
      
      
  
  
  
  
    
    
    
    
      
      
        
      
    
    
    <li class="md-nav__item md-nav__item--nested">
      
        
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
        
          
          <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
            
  
  
  <span class="md-ellipsis">
    
  
    Aster Chain
  

    
  </span>
  
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_5">
            <span class="md-nav__icon md-icon"></span>
            
  
    Aster Chain
  

          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../aster-chain/endpoints/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    Endpoints
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
          </ul>
        </nav>
      
    </li>
  

    
      
      
  
  
  
  
    
    
    
    
      
      
        
      
    
    
    <li class="md-nav__item md-nav__item--nested">
      
        
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
        
          
          <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
            
  
  
  <span class="md-ellipsis">
    
  
    BAPI
  

    
  </span>
  
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_6">
            <span class="md-nav__icon md-icon"></span>
            
  
    BAPI
  

          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../bapi/announcement/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    Announcement
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../bapi/portfolio/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    Portfolio
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
          </ul>
        </nav>
      
    </li>
  

    
      
      
  
  
  
  
    
    
    
    
      
      
        
      
    
    
    <li class="md-nav__item md-nav__item--nested">
      
        
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
        
          
          <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
            
  
  
  <span class="md-ellipsis">
    
  
    Futures Testnet
  

    
  </span>
  
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_7">
            <span class="md-nav__icon md-icon"></span>
            
  
    Futures Testnet
  

          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../futures-testnet/general-info/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    General Info
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../futures-testnet/market-data/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    Market Data
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../futures-testnet/account%26trades/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    Futures Account & Trading
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../futures-testnet/websocket-market-streams/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    WebSocket Market Data
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../futures-testnet/user-data-streams/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    WebSocket Account Info
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../futures-testnet/error-codes/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    Error Codes
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
          </ul>
        </nav>
      
    </li>
  

    
      
      
  
  
  
  
    
    
    
    
      
      
        
      
    
    
    <li class="md-nav__item md-nav__item--nested">
      
        
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" >
        
          
          <label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
            
  
  
  <span class="md-ellipsis">
    
  
    Spot Testnet
  

    
  </span>
  
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_8">
            <span class="md-nav__icon md-icon"></span>
            
  
    Spot Testnet
  

          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../spot-testnet/general-info/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    General Info
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../spot-testnet/market-data/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    Market Data
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../spot-testnet/account%26trades/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    Spot Account & Trading
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../spot-testnet/websocket-market-streams/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    WebSocket Market Data
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../spot-testnet/websocket-account-info/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    WebSocket Account Info
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../spot-testnet/error-codes/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    Error Codes
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
          </ul>
        </nav>
      
    </li>
  

    
      
      
  
  
  
  
    
    
    
    
      
      
        
      
    
    
    <li class="md-nav__item md-nav__item--nested">
      
        
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9" >
        
          
          <label class="md-nav__link" for="__nav_9" id="__nav_9_label" tabindex="0">
            
  
  
  <span class="md-ellipsis">
    
  
    Prediction Testnet
  

    
  </span>
  
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_9">
            <span class="md-nav__icon md-icon"></span>
            
  
    Prediction Testnet
  

          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../prediction-testnet/general-info/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    General Info
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../prediction-testnet/market-data/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    Market Data
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../prediction-testnet/account%26trades/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    Spot Account & Trading
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../prediction-testnet/websocket-market-streams/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    WebSocket Market Data
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../prediction-testnet/user-data-streams/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    WebSocket Account Info
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../prediction-testnet/error-codes/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    Error Codes
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
          </ul>
        </nav>
      
    </li>
  

    
      
      
  
  
  
  
    <li class="md-nav__item">
      <a href="../../demo/demo/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    Demo
  

    
  </span>
  
  

      </a>
    </li>
  

    
      
      
  
  
  
  
    
    
    
    
      
      
        
      
    
    
    <li class="md-nav__item md-nav__item--nested">
      
        
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_11" >
        
          
          <label class="md-nav__link" for="__nav_11" id="__nav_11_label" tabindex="0">
            
  
  
  <span class="md-ellipsis">
    
  
    Changelog
  

    
  </span>
  
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_11">
            <span class="md-nav__icon md-icon"></span>
            
  
    Changelog
  

          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/upcoming-changes/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    Upcoming Changes
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-10-27/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-10-27
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-10-22/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-10-22
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-10-21/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-10-21
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-10-19/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-10-19
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-10-8/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-10-8
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-8-26/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-8-26
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-8-17/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-8-17
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-7-16/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-7-16
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-7-10/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-7-10
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-7-7/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-7-7
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-6-30/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-6-30
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-6-25/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-6-25
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-6-24/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-6-24
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-6-17/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-6-17
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-6-2/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-6-2
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-5-26/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-5-26
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-5-22/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-5-22
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-5-21/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-5-21
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-5-20/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-5-20
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-5-12/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-5-12
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-5-11/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-5-11
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-5-07/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-5-07
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-4-28/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-4-28
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-4-24/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-4-24
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-4-10/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-4-10
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-4-09/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-4-09
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-4-03/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-4-03
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-3-31/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-3-31
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-3-28/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-3-28
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-3-21/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-3-21
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-3-19/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-3-19
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-3-18/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-3-18
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-3-17/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-3-17
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-3-11/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-3-11
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../changelog/2026-1-27/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    
  
    2026-1-27
  

    
  </span>
  
  

      </a>
    </li>
  

              
            
          </ul>
        </nav>
      
    </li>
  

    
  </ul>
</nav>
                  </div>
                </div>
              </div>
            
            
              
              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
                <div class="md-sidebar__scrollwrap">
                  <div class="md-sidebar__inner">
                    

<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  
  
  
  
    <label class="md-nav__title" for="__toc">
      <span class="md-nav__icon md-icon"></span>
      Table of contents
    </label>
    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
      
        <li class="md-nav__item">
  <a href="#general-api-information" class="md-nav__link">
    <span class="md-ellipsis">
      
        General API Information
      
    </span>
  </a>
  
    <nav class="md-nav" aria-label="General API Information">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#http-return-codes" class="md-nav__link">
    <span class="md-ellipsis">
      
        HTTP Return Codes
      
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#error-codes-and-messages" class="md-nav__link">
    <span class="md-ellipsis">
      
        Error Codes and Messages
      
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#general-information-on-endpoints" class="md-nav__link">
    <span class="md-ellipsis">
      
        General Information on Endpoints
      
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#limits" class="md-nav__link">
    <span class="md-ellipsis">
      
        LIMITS
      
    </span>
  </a>
  
    <nav class="md-nav" aria-label="LIMITS">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#ip-limits" class="md-nav__link">
    <span class="md-ellipsis">
      
        IP Limits
      
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#order-rate-limits" class="md-nav__link">
    <span class="md-ellipsis">
      
        Order Rate Limits
      
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#endpoint-security-type" class="md-nav__link">
    <span class="md-ellipsis">
      
        Endpoint Security Type
      
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#signed-trade-and-user_data-endpoint-security" class="md-nav__link">
    <span class="md-ellipsis">
      
        SIGNED (TRADE and USER_DATA) Endpoint Security
      
    </span>
  </a>
  
    <nav class="md-nav" aria-label="SIGNED (TRADE and USER_DATA) Endpoint Security">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#timing-security" class="md-nav__link">
    <span class="md-ellipsis">
      
        Timing Security
      
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#signed-endpoint-examples-for-post-fapiv1order" class="md-nav__link">
    <span class="md-ellipsis">
      
        SIGNED Endpoint Examples for POST /fapi/v1/order
      
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#public-endpoints-info" class="md-nav__link">
    <span class="md-ellipsis">
      
        Public Endpoints Info
      
    </span>
  </a>
  
    <nav class="md-nav" aria-label="Public Endpoints Info">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#terminology" class="md-nav__link">
    <span class="md-ellipsis">
      
        Terminology
      
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#enum-definitions" class="md-nav__link">
    <span class="md-ellipsis">
      
        ENUM definitions
      
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#filters" class="md-nav__link">
    <span class="md-ellipsis">
      
        Filters
      
    </span>
  </a>
  
    <nav class="md-nav" aria-label="Filters">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#symbol-filters" class="md-nav__link">
    <span class="md-ellipsis">
      
        Symbol filters
      
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
    </ul>
  
</nav>
                  </div>
                </div>
              </div>
            
          
          
            <div class="md-content" data-md-component="content">
              
              <article class="md-content__inner md-typeset">
                
                  



  <h1>General info</h1>

<h2 id="general-api-information"><strong>General API Information</strong><a class="headerlink" href="#general-api-information" title="Permanent link">&para;</a></h2>
<ul>
<li>Some endpoints will require an API Key. Please refer to <a href="https://www.asterdex.com/">this page</a></li>
<li>The base endpoint is: <strong>https://fapi.asterdex.com</strong></li>
<li>All endpoints return either a JSON object or array.</li>
<li>Data is returned in <strong>ascending</strong> order. Oldest first, newest last.</li>
<li>All time and timestamp related fields are in milliseconds.</li>
<li>All data types adopt definition in JAVA.</li>
</ul>
<h3 id="http-return-codes">HTTP Return Codes<a class="headerlink" href="#http-return-codes" title="Permanent link">&para;</a></h3>
<ul>
<li>HTTP <code>4XX</code> return codes are used for for malformed requests;
  the issue is on the sender's side.</li>
<li>HTTP <code>403</code> return code is used when the WAF Limit (Web Application Firewall) has been violated.  </li>
<li>HTTP <code>429</code> return code is used when breaking a request rate limit.</li>
<li>HTTP <code>418</code> return code is used when an IP has been auto-banned for continuing to send requests after receiving <code>429</code> codes.</li>
<li>HTTP <code>5XX</code> return codes are used for internal errors; the issue is on
  Aster's side.   </li>
<li>HTTP <code>503</code> return code is used when the API successfully sent the message but not get a response within the timeout period. <br />
  It is important to <strong>NOT</strong> treat this as a failure operation; the execution status is
  <strong>UNKNOWN</strong> and could have been a success.</li>
</ul>
<h3 id="error-codes-and-messages">Error Codes and Messages<a class="headerlink" href="#error-codes-and-messages" title="Permanent link">&para;</a></h3>
<ul>
<li>Any endpoint can return an ERROR</li>
</ul>
<blockquote>
<p><strong><em>The error payload is as follows:</em></strong></p>
</blockquote>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="w">  </span><span class="s2">&quot;code&quot;</span><span class="o">:</span><span class="w"> </span><span class="o">-</span><span class="mf">1121</span><span class="p">,</span>
<span class="w">  </span><span class="s2">&quot;msg&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;Invalid symbol.&quot;</span>
<span class="p">}</span>
</code></pre></div>
<ul>
<li>Specific error codes and messages defined in <strong>Error Codes</strong> Page.</li>
</ul>
<h3 id="general-information-on-endpoints">General Information on Endpoints<a class="headerlink" href="#general-information-on-endpoints" title="Permanent link">&para;</a></h3>
<ul>
<li>For <code>GET</code> endpoints, parameters must be sent as a <code>query string</code>.</li>
<li>For <code>POST</code>, <code>PUT</code>, and <code>DELETE</code> endpoints, the parameters may be sent as a
  <code>query string</code> or in the <code>request body</code> with content type
  <code>application/x-www-form-urlencoded</code>. You may mix parameters between both the
  <code>query string</code> and <code>request body</code> if you wish to do so.</li>
<li>Parameters may be sent in any order.</li>
<li>If a parameter sent in both the <code>query string</code> and <code>request body</code>, the
  <code>query string</code> parameter will be used.</li>
</ul>
<h2 id="limits"><strong>LIMITS</strong><a class="headerlink" href="#limits" title="Permanent link">&para;</a></h2>
<ul>
<li>The <code>/fapi/v1/exchangeInfo</code> <code>rateLimits</code> array contains objects related to the exchange's <code>RAW_REQUEST</code>, <code>REQUEST_WEIGHT</code>, and <code>ORDER</code> rate limits. These are further defined in the <code>ENUM definitions</code> section under <code>Rate limiters (rateLimitType)</code>.</li>
<li>A <code>429</code> will be returned when either rate limit is violated.</li>
</ul>
<aside class="notice">
Aster Finance has the right to further tighten the rate limits on users with intent to attack.
</aside>

<h3 id="ip-limits">IP Limits<a class="headerlink" href="#ip-limits" title="Permanent link">&para;</a></h3>
<ul>
<li>Every request will contain <code>X-MBX-USED-WEIGHT-(intervalNum)(intervalLetter)</code> in the response headers which has the current used weight for the IP for all request rate limiters defined.</li>
<li>Each route has a <code>weight</code> which determines for the number of requests each endpoint counts for. Heavier endpoints and endpoints that do operations on multiple symbols will have a heavier <code>weight</code>.</li>
<li>When a 429 is received, it's your obligation as an API to back off and not spam the API.</li>
<li><strong>Repeatedly violating rate limits and/or failing to back off after receiving 429s will result in an automated IP ban (HTTP status 418).</strong></li>
<li>IP bans are tracked and <strong>scale in duration</strong> for repeat offenders, <strong>from 2 minutes to 3 days</strong>.</li>
<li><strong>The limits on the API are based on the IPs, not the API keys.</strong></li>
</ul>
<aside class="notice">
It is strongly recommended to use websocket stream for getting data as much as possible, which can not only ensure the timeliness of the message, but also reduce the access restriction pressure caused by the request.
</aside>

<h3 id="order-rate-limits">Order Rate Limits<a class="headerlink" href="#order-rate-limits" title="Permanent link">&para;</a></h3>
<ul>
<li>Every order response will contain a <code>X-MBX-ORDER-COUNT-(intervalNum)(intervalLetter)</code> header which has the current order count for the account for all order rate limiters defined.</li>
<li>Rejected/unsuccessful orders are not guaranteed to have <code>X-MBX-ORDER-COUNT-**</code> headers in the response.</li>
<li><strong>The order rate limit is counted against each account</strong>.</li>
</ul>
<h2 id="endpoint-security-type"><strong>Endpoint Security Type</strong><a class="headerlink" href="#endpoint-security-type" title="Permanent link">&para;</a></h2>
<ul>
<li>Each endpoint has a security type that determines the how you will
  interact with it.</li>
<li>API-keys are passed into the Rest API via the <code>X-MBX-APIKEY</code>
  header.</li>
<li>API-keys and secret-keys <strong>are case sensitive</strong>.</li>
<li>API-keys can be configured to only access certain types of secure endpoints.
 For example, one API-key could be used for TRADE only, while another API-key
 can access everything except for TRADE routes.</li>
<li>By default, API-keys can access all secure routes.</li>
</ul>
<table>
<thead>
<tr>
<th>Security Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>NONE</td>
<td>Endpoint can be accessed freely.</td>
</tr>
<tr>
<td>TRADE</td>
<td>Endpoint requires sending a valid API-Key and signature.</td>
</tr>
<tr>
<td>USER_DATA</td>
<td>Endpoint requires sending a valid API-Key and signature.</td>
</tr>
<tr>
<td>USER_STREAM</td>
<td>Endpoint requires sending a valid API-Key.</td>
</tr>
<tr>
<td>MARKET_DATA</td>
<td>Endpoint requires sending a valid API-Key.</td>
</tr>
</tbody>
</table>
<ul>
<li><code>TRADE</code> and <code>USER_DATA</code> endpoints are <code>SIGNED</code> endpoints.</li>
</ul>
<h2 id="signed-trade-and-user_data-endpoint-security"><strong>SIGNED (TRADE and USER_DATA) Endpoint Security</strong><a class="headerlink" href="#signed-trade-and-user_data-endpoint-security" title="Permanent link">&para;</a></h2>
<ul>
<li><code>SIGNED</code> endpoints require an additional parameter, <code>signature</code>, to be
  sent in the  <code>query string</code> or <code>request body</code>.</li>
<li>Endpoints use <code>HMAC SHA256</code> signatures. The <code>HMAC SHA256 signature</code> is a keyed <code>HMAC SHA256</code> operation.
  Use your <code>secretKey</code> as the key and <code>totalParams</code> as the value for the HMAC operation.</li>
<li>The <code>signature</code> is <strong>not case sensitive</strong>.</li>
<li>Please make sure the <code>signature</code> is the end part of your <code>query string</code> or <code>request body</code>.</li>
<li><code>totalParams</code> is defined as the <code>query string</code> concatenated with the
  <code>request body</code>.</li>
</ul>
<h3 id="timing-security">Timing Security<a class="headerlink" href="#timing-security" title="Permanent link">&para;</a></h3>
<ul>
<li>A <code>SIGNED</code> endpoint also requires a parameter, <code>timestamp</code>, to be sent which
  should be the millisecond timestamp of when the request was created and sent.</li>
<li>An additional parameter, <code>recvWindow</code>, may be sent to specify the number of
  milliseconds after <code>timestamp</code> the request is valid for. If <code>recvWindow</code>
  is not sent, <strong>it defaults to 5000</strong>.</li>
</ul>
<blockquote>
<p>The logic is as follows:</p>
</blockquote>
<div class="highlight"><pre><span></span><code><span class="w">  </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nx">timestamp</span><span class="w"> </span><span class="o">&lt;</span><span class="w"> </span><span class="p">(</span><span class="nx">serverTime</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="mf">1000</span><span class="p">)</span><span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="p">(</span><span class="nx">serverTime</span><span class="w"> </span><span class="o">-</span><span class="w"> </span><span class="nx">timestamp</span><span class="p">)</span><span class="w"> </span><span class="o">&lt;=</span><span class="w"> </span><span class="nx">recvWindow</span><span class="p">){</span>
<span class="w">    </span><span class="c1">// process request</span>
<span class="w">  </span><span class="p">}</span><span class="w"> </span>
<span class="w">  </span><span class="k">else</span><span class="w"> </span><span class="p">{</span>
<span class="w">    </span><span class="c1">// reject request</span>
<span class="w">  </span><span class="p">}</span>
</code></pre></div>
<p><strong>Serious trading is about timing.</strong> Networks can be unstable and unreliable,
which can lead to requests taking varying amounts of time to reach the
servers. With <code>recvWindow</code>, you can specify that the request must be
processed within a certain number of milliseconds or be rejected by the
server.</p>
<aside class="notice">
It is recommended to use a small recvWindow of 5000 or less!
</aside>

<h3 id="signed-endpoint-examples-for-post-fapiv1order">SIGNED Endpoint Examples for POST /fapi/v1/order<a class="headerlink" href="#signed-endpoint-examples-for-post-fapiv1order" title="Permanent link">&para;</a></h3>
<p>Here is a step-by-step example of how to send a vaild signed payload from the
Linux command line using <code>echo</code>, <code>openssl</code>, and <code>curl</code>.</p>
<table>
<thead>
<tr>
<th>Key</th>
<th>Value</th>
</tr>
</thead>
<tbody>
<tr>
<td>apiKey</td>
<td>dbefbc809e3e83c283a984c3a1459732ea7db1360ca80c5c2c8867408d28cc83</td>
</tr>
<tr>
<td>secretKey</td>
<td>2b5eb11e18796d12d88f13dc27dbbd02c2cc51ff7059765ed9821957d82bb4d9</td>
</tr>
</tbody>
</table>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Value</th>
</tr>
</thead>
<tbody>
<tr>
<td>symbol</td>
<td>BTCUSDT</td>
</tr>
<tr>
<td>side</td>
<td>BUY</td>
</tr>
<tr>
<td>type</td>
<td>LIMIT</td>
</tr>
<tr>
<td>timeInForce</td>
<td>GTC</td>
</tr>
<tr>
<td>quantity</td>
<td>1</td>
</tr>
<tr>
<td>price</td>
<td>9000</td>
</tr>
<tr>
<td>recvWindow</td>
<td>5000</td>
</tr>
<tr>
<td>timestamp</td>
<td>1591702613943</td>
</tr>
</tbody>
</table>
<h4 id="example-1-as-a-query-string">Example 1: As a query string<a class="headerlink" href="#example-1-as-a-query-string" title="Permanent link">&para;</a></h4>
<blockquote>
<p><strong>Example 1</strong></p>
<p><strong>HMAC SHA256 signature:</strong></p>
</blockquote>
<div class="highlight"><pre><span></span><code><span class="w">    </span>$<span class="w"> </span><span class="nb">echo</span><span class="w"> </span>-n<span class="w"> </span><span class="s2">&quot;symbol=BTCUSDT&amp;side=BUY&amp;type=LIMIT&amp;quantity=1&amp;price=9000&amp;timeInForce=GTC&amp;recvWindow=5000&amp;timestamp=1591702613943&quot;</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>openssl<span class="w"> </span>dgst<span class="w"> </span>-sha256<span class="w"> </span>-hmac<span class="w"> </span><span class="s2">&quot;2b5eb11e18796d12d88f13dc27dbbd02c2cc51ff7059765ed9821957d82bb4d9&quot;</span>
<span class="w">    </span><span class="o">(</span>stdin<span class="o">)=</span><span class="w"> </span>3c661234138461fcc7a7d8746c6558c9842d4e10870d2ecbedf7777cad694af9
</code></pre></div>
<blockquote>
<p><strong>curl command:</strong></p>
</blockquote>
<p><div class="highlight"><pre><span></span><code><span class="w">    </span><span class="o">(</span>HMAC<span class="w"> </span>SHA256<span class="o">)</span>
<span class="w">    </span>$<span class="w"> </span>curl<span class="w"> </span>-H<span class="w"> </span><span class="s2">&quot;X-MBX-APIKEY: dbefbc809e3e83c283a984c3a1459732ea7db1360ca80c5c2c8867408d28cc83&quot;</span><span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span><span class="s1">&#39;https://fapi/asterdex.com/fapi/v1/order?symbol=BTCUSDT&amp;side=BUY&amp;type=LIMIT&amp;quantity=1&amp;price=9000&amp;timeInForce=GTC&amp;recvWindow=5000&amp;timestamp=1591702613943&amp;signature= 3c661234138461fcc7a7d8746c6558c9842d4e10870d2ecbedf7777cad694af9&#39;</span>
</code></pre></div>
* <strong>queryString:</strong> </p>
<div class="highlight"><pre><span></span><code>symbol=BTCUSDT  
&amp;side=BUY   
&amp;type=LIMIT  
&amp;timeInForce=GTC   
&amp;quantity=1  
&amp;price=9000   
&amp;recvWindow=5000   
&amp;timestamp=1591702613943
</code></pre></div>
<h4 id="example-2-as-a-request-body">Example 2: As a request body<a class="headerlink" href="#example-2-as-a-request-body" title="Permanent link">&para;</a></h4>
<blockquote>
<p><strong>Example 2</strong></p>
<p><strong>HMAC SHA256 signature:</strong></p>
</blockquote>
<div class="highlight"><pre><span></span><code><span class="w">    </span>$<span class="w"> </span><span class="nb">echo</span><span class="w"> </span>-n<span class="w"> </span><span class="s2">&quot;symbol=BTCUSDT&amp;side=BUY&amp;type=LIMIT&amp;quantity=1&amp;price=9000&amp;timeInForce=GTC&amp;recvWindow=5000&amp;timestamp=1591702613943&quot;</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>openssl<span class="w"> </span>dgst<span class="w"> </span>-sha256<span class="w"> </span>-hmac<span class="w"> </span><span class="s2">&quot;2b5eb11e18796d12d88f13dc27dbbd02c2cc51ff7059765ed9821957d82bb4d9&quot;</span>
<span class="w">    </span><span class="o">(</span>stdin<span class="o">)=</span><span class="w"> </span>3c661234138461fcc7a7d8746c6558c9842d4e10870d2ecbedf7777cad694af9
</code></pre></div>
<blockquote>
<p><strong>curl command:</strong></p>
</blockquote>
<div class="highlight"><pre><span></span><code><span class="w">    </span><span class="o">(</span>HMAC<span class="w"> </span>SHA256<span class="o">)</span>
<span class="w">    </span>$<span class="w"> </span>curl<span class="w"> </span>-H<span class="w"> </span><span class="s2">&quot;X-MBX-APIKEY: dbefbc809e3e83c283a984c3a1459732ea7db1360ca80c5c2c8867408d28cc83&quot;</span><span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span><span class="s1">&#39;https://fapi/asterdex.com/fapi/v1/order&#39;</span><span class="w"> </span>-d<span class="w"> </span><span class="s1">&#39;symbol=BTCUSDT&amp;side=BUY&amp;type=LIMIT&amp;quantity=1&amp;price=9000&amp;timeInForce=GTC&amp;recvWindow=5000&amp;timestamp=1591702613943&amp;signature= 3c661234138461fcc7a7d8746c6558c9842d4e10870d2ecbedf7777cad694af9&#39;</span>
</code></pre></div>
<ul>
<li>
<p><strong>requestBody:</strong></p>
<p>symbol=BTCUSDT <br />
&amp;side=BUY <br />
&amp;type=LIMIT <br />
&amp;timeInForce=GTC <br />
&amp;quantity=1 <br />
&amp;price=9000<br />
&amp;recvWindow=5000 <br />
&amp;timestamp=1591702613943</p>
</li>
</ul>
<h4 id="example-3-mixed-query-string-and-request-body">Example 3: Mixed query string and request body<a class="headerlink" href="#example-3-mixed-query-string-and-request-body" title="Permanent link">&para;</a></h4>
<blockquote>
<p><strong>Example 3</strong></p>
<p><strong>HMAC SHA256 signature:</strong></p>
</blockquote>
<div class="highlight"><pre><span></span><code><span class="w">    </span>$<span class="w"> </span><span class="nb">echo</span><span class="w"> </span>-n<span class="w"> </span><span class="s2">&quot;symbol=BTCUSDT&amp;side=BUY&amp;type=LIMIT&amp;quantity=1&amp;price=9000&amp;timeInForce=GTC&amp;recvWindow=5000&amp;timestamp=1591702613943&quot;</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>openssl<span class="w"> </span>dgst<span class="w"> </span>-sha256<span class="w"> </span>-hmac<span class="w"> </span><span class="s2">&quot;2b5eb11e18796d12d88f13dc27dbbd02c2cc51ff7059765ed9821957d82bb4d9&quot;</span>
<span class="w">    </span><span class="o">(</span>stdin<span class="o">)=</span><span class="w"> </span>3c661234138461fcc7a7d8746c6558c9842d4e10870d2ecbedf7777cad694af9
</code></pre></div>
<blockquote>
<p><strong>curl command:</strong></p>
</blockquote>
<div class="highlight"><pre><span></span><code><span class="w">    </span><span class="o">(</span>HMAC<span class="w"> </span>SHA256<span class="o">)</span>
<span class="w">    </span>$<span class="w"> </span>curl<span class="w"> </span>-H<span class="w"> </span><span class="s2">&quot;X-MBX-APIKEY: dbefbc809e3e83c283a984c3a1459732ea7db1360ca80c5c2c8867408d28cc83&quot;</span><span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span><span class="s1">&#39;https://fapi/asterdex.com/fapi/v1/order?symbol=BTCUSDT&amp;side=BUY&amp;type=LIMIT&amp;timeInForce=GTC&#39;</span><span class="w"> </span>-d<span class="w"> </span><span class="s1">&#39;quantity=1&amp;price=9000&amp;recvWindow=5000&amp;timestamp=1591702613943&amp;signature=3c661234138461fcc7a7d8746c6558c9842d4e10870d2ecbedf7777cad694af9&#39;</span>
</code></pre></div>
<ul>
<li><strong>queryString:</strong> symbol=BTCUSDT&amp;side=BUY&amp;type=LIMIT&amp;timeInForce=GTC</li>
<li><strong>requestBody:</strong> quantity=1&amp;price=9000&amp;recvWindow=5000&amp;timestamp= 1591702613943</li>
</ul>
<p>Note that the signature is different in example 3.   <br />
There is no &amp; between "GTC" and "quantity=1".</p>
<h2 id="public-endpoints-info"><strong>Public Endpoints Info</strong><a class="headerlink" href="#public-endpoints-info" title="Permanent link">&para;</a></h2>
<h3 id="terminology">Terminology<a class="headerlink" href="#terminology" title="Permanent link">&para;</a></h3>
<ul>
<li><code>base asset</code> refers to the asset that is the <code>quantity</code> of a symbol.</li>
<li><code>quote asset</code> refers to the asset that is the <code>price</code> of a symbol.</li>
</ul>
<h3 id="enum-definitions">ENUM definitions<a class="headerlink" href="#enum-definitions" title="Permanent link">&para;</a></h3>
<p><strong>Symbol type:</strong></p>
<ul>
<li>FUTURE</li>
</ul>
<p><strong>Contract type (contractType):</strong></p>
<ul>
<li>PERPETUAL </li>
</ul>
<p><strong>Contract status(contractStatus，status):</strong></p>
<ul>
<li>PENDING_TRADING </li>
<li>TRADING </li>
<li>PRE_SETTLE    </li>
<li>SETTLING  </li>
<li>CLOSE </li>
</ul>
<p><strong>Order status (status):</strong></p>
<ul>
<li>NEW</li>
<li>PARTIALLY_FILLED</li>
<li>FILLED</li>
<li>CANCELED</li>
<li>REJECTED</li>
<li>EXPIRED</li>
</ul>
<p><strong>Order types (orderTypes, type):</strong></p>
<ul>
<li>LIMIT </li>
<li>MARKET </li>
<li>STOP </li>
<li>STOP_MARKET </li>
<li>TAKE_PROFIT </li>
<li>TAKE_PROFIT_MARKET </li>
<li>TRAILING_STOP_MARKET</li>
</ul>
<p><strong>Order side (side):</strong></p>
<ul>
<li>BUY</li>
<li>SELL</li>
</ul>
<p><strong>Position side (positionSide):</strong></p>
<ul>
<li>BOTH </li>
<li>LONG </li>
<li>SHORT </li>
</ul>
<p><strong>Time in force (timeInForce):</strong></p>
<ul>
<li>GTC - Good Till Cancel</li>
<li>IOC - Immediate or Cancel</li>
<li>FOK - Fill or Kill</li>
<li>GTX - Good Till Crossing  (Post Only) </li>
<li>HIDDEN - HIDDEN This type of order is not visible in the order book</li>
</ul>
<p><strong>Working Type (workingType)</strong></p>
<ul>
<li>MARK_PRICE</li>
<li>CONTRACT_PRICE </li>
</ul>
<p><strong>Response Type (newOrderRespType)</strong></p>
<ul>
<li>ACK</li>
<li>RESULT</li>
</ul>
<p><strong>Kline/Candlestick chart intervals:</strong></p>
<p>m -&gt; minutes; h -&gt; hours; d -&gt; days; w -&gt; weeks; M -&gt; months</p>
<ul>
<li>1m</li>
<li>3m</li>
<li>5m</li>
<li>15m</li>
<li>30m</li>
<li>1h</li>
<li>2h</li>
<li>4h</li>
<li>6h</li>
<li>8h</li>
<li>12h</li>
<li>1d</li>
<li>3d</li>
<li>1w</li>
<li>1M</li>
</ul>
<p><strong>Rate limiters (rateLimitType)</strong></p>
<blockquote>
<p>REQUEST_WEIGHT</p>
</blockquote>
<div class="highlight"><pre><span></span><code><span class="w">  </span><span class="p">{</span>
<span class="w">    </span><span class="s2">&quot;rateLimitType&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;REQUEST_WEIGHT&quot;</span><span class="p">,</span>
<span class="w">    </span><span class="s2">&quot;interval&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;MINUTE&quot;</span><span class="p">,</span>
<span class="w">    </span><span class="s2">&quot;intervalNum&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">1</span><span class="p">,</span>
<span class="w">    </span><span class="s2">&quot;limit&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">2400</span>
<span class="w">  </span><span class="p">}</span>
</code></pre></div>
<blockquote>
<p>ORDERS</p>
</blockquote>
<div class="highlight"><pre><span></span><code><span class="w">  </span><span class="p">{</span>
<span class="w">    </span><span class="s2">&quot;rateLimitType&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;ORDERS&quot;</span><span class="p">,</span>
<span class="w">    </span><span class="s2">&quot;interval&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;MINUTE&quot;</span><span class="p">,</span>
<span class="w">    </span><span class="s2">&quot;intervalNum&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">1</span><span class="p">,</span>
<span class="w">    </span><span class="s2">&quot;limit&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">1200</span>
<span class="w">   </span><span class="p">}</span>
</code></pre></div>
<ul>
<li>
<p>REQUEST_WEIGHT</p>
</li>
<li>
<p>ORDERS</p>
</li>
</ul>
<p><strong>Rate limit intervals (interval)</strong></p>
<ul>
<li>MINUTE</li>
</ul>
<h2 id="filters"><strong>Filters</strong><a class="headerlink" href="#filters" title="Permanent link">&para;</a></h2>
<p>Filters define trading rules on a symbol or an exchange.</p>
<h3 id="symbol-filters">Symbol filters<a class="headerlink" href="#symbol-filters" title="Permanent link">&para;</a></h3>
<h4 id="price_filter">PRICE_FILTER<a class="headerlink" href="#price_filter" title="Permanent link">&para;</a></h4>
<blockquote>
<p><strong>/exchangeInfo format:</strong></p>
</blockquote>
<div class="highlight"><pre><span></span><code><span class="w">  </span><span class="p">{</span>
<span class="w">    </span><span class="s2">&quot;filterType&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;PRICE_FILTER&quot;</span><span class="p">,</span>
<span class="w">    </span><span class="s2">&quot;minPrice&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;0.00000100&quot;</span><span class="p">,</span>
<span class="w">    </span><span class="s2">&quot;maxPrice&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;100000.00000000&quot;</span><span class="p">,</span>
<span class="w">    </span><span class="s2">&quot;tickSize&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;0.00000100&quot;</span>
<span class="w">  </span><span class="p">}</span>
</code></pre></div>
<p>The <code>PRICE_FILTER</code> defines the <code>price</code> rules for a symbol. There are 3 parts:</p>
<ul>
<li><code>minPrice</code> defines the minimum <code>price</code>/<code>stopPrice</code> allowed; disabled on <code>minPrice</code> == 0.</li>
<li><code>maxPrice</code> defines the maximum <code>price</code>/<code>stopPrice</code> allowed; disabled on <code>maxPrice</code> == 0.</li>
<li><code>tickSize</code> defines the intervals that a <code>price</code>/<code>stopPrice</code> can be increased/decreased by; disabled on <code>tickSize</code> == 0.</li>
</ul>
<p>Any of the above variables can be set to 0, which disables that rule in the <code>price filter</code>. In order to pass the <code>price filter</code>, the following must be true for <code>price</code>/<code>stopPrice</code> of the enabled rules:</p>
<ul>
<li><code>price</code> &gt;= <code>minPrice</code> </li>
<li><code>price</code> &lt;= <code>maxPrice</code></li>
<li>(<code>price</code>-<code>minPrice</code>) % <code>tickSize</code> == 0</li>
</ul>
<h4 id="lot_size">LOT_SIZE<a class="headerlink" href="#lot_size" title="Permanent link">&para;</a></h4>
<blockquote>
<p><strong>/exchangeInfo format:</strong></p>
</blockquote>
<div class="highlight"><pre><span></span><code><span class="w">  </span><span class="p">{</span>
<span class="w">    </span><span class="s2">&quot;filterType&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;LOT_SIZE&quot;</span><span class="p">,</span>
<span class="w">    </span><span class="s2">&quot;minQty&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;0.00100000&quot;</span><span class="p">,</span>
<span class="w">    </span><span class="s2">&quot;maxQty&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;100000.00000000&quot;</span><span class="p">,</span>
<span class="w">    </span><span class="s2">&quot;stepSize&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;0.00100000&quot;</span>
<span class="w">  </span><span class="p">}</span>
</code></pre></div>
<p>The <code>LOT_SIZE</code> filter defines the <code>quantity</code> (aka "lots" in auction terms) rules for a symbol. There are 3 parts:</p>
<ul>
<li><code>minQty</code> defines the minimum <code>quantity</code> allowed.</li>
<li><code>maxQty</code> defines the maximum <code>quantity</code> allowed.</li>
<li><code>stepSize</code> defines the intervals that a <code>quantity</code> can be increased/decreased by.</li>
</ul>
<p>In order to pass the <code>lot size</code>, the following must be true for <code>quantity</code>:</p>
<ul>
<li><code>quantity</code> &gt;= <code>minQty</code></li>
<li><code>quantity</code> &lt;= <code>maxQty</code></li>
<li>(<code>quantity</code>-<code>minQty</code>) % <code>stepSize</code> == 0</li>
</ul>
<h4 id="market_lot_size">MARKET_LOT_SIZE<a class="headerlink" href="#market_lot_size" title="Permanent link">&para;</a></h4>
<blockquote>
<p><strong>/exchangeInfo format:</strong></p>
</blockquote>
<div class="highlight"><pre><span></span><code><span class="w">  </span><span class="p">{</span>
<span class="w">    </span><span class="s2">&quot;filterType&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;MARKET_LOT_SIZE&quot;</span><span class="p">,</span>
<span class="w">    </span><span class="s2">&quot;minQty&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;0.00100000&quot;</span><span class="p">,</span>
<span class="w">    </span><span class="s2">&quot;maxQty&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;100000.00000000&quot;</span><span class="p">,</span>
<span class="w">    </span><span class="s2">&quot;stepSize&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;0.00100000&quot;</span>
<span class="w">  </span><span class="p">}</span>
</code></pre></div>
<p>The <code>MARKET_LOT_SIZE</code> filter defines the <code>quantity</code> (aka "lots" in auction terms) rules for <code>MARKET</code> orders on a symbol. There are 3 parts:</p>
<ul>
<li><code>minQty</code> defines the minimum <code>quantity</code> allowed.</li>
<li><code>maxQty</code> defines the maximum <code>quantity</code> allowed.</li>
<li><code>stepSize</code> defines the intervals that a <code>quantity</code> can be increased/decreased by.</li>
</ul>
<p>In order to pass the <code>market lot size</code>, the following must be true for <code>quantity</code>:</p>
<ul>
<li><code>quantity</code> &gt;= <code>minQty</code></li>
<li><code>quantity</code> &lt;= <code>maxQty</code></li>
<li>(<code>quantity</code>-<code>minQty</code>) % <code>stepSize</code> == 0</li>
</ul>
<h4 id="max_num_orders">MAX_NUM_ORDERS<a class="headerlink" href="#max_num_orders" title="Permanent link">&para;</a></h4>
<blockquote>
<p><strong>/exchangeInfo format:</strong></p>
</blockquote>
<div class="highlight"><pre><span></span><code><span class="w">  </span><span class="p">{</span>
<span class="w">    </span><span class="s2">&quot;filterType&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;MAX_NUM_ORDERS&quot;</span><span class="p">,</span>
<span class="w">    </span><span class="s2">&quot;limit&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">200</span>
<span class="w">  </span><span class="p">}</span>
</code></pre></div>
<p>The <code>MAX_NUM_ORDERS</code> filter defines the maximum number of orders an account is allowed to have open on a symbol.</p>
<p>Note that both "algo" orders and normal orders are counted for this filter.</p>
<h4 id="max_num_algo_orders">MAX_NUM_ALGO_ORDERS<a class="headerlink" href="#max_num_algo_orders" title="Permanent link">&para;</a></h4>
<blockquote>
<p><strong>/exchangeInfo format:</strong></p>
</blockquote>
<div class="highlight"><pre><span></span><code><span class="w">  </span><span class="p">{</span>
<span class="w">    </span><span class="s2">&quot;filterType&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;MAX_NUM_ALGO_ORDERS&quot;</span><span class="p">,</span>
<span class="w">    </span><span class="s2">&quot;limit&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">100</span>
<span class="w">  </span><span class="p">}</span>
</code></pre></div>
<p>The <code>MAX_NUM_ALGO_ORDERS</code> filter defines the maximum number of all kinds of algo orders an account is allowed to have open on a symbol.</p>
<p>The algo orders include <code>STOP</code>, <code>STOP_MARKET</code>, <code>TAKE_PROFIT</code>, <code>TAKE_PROFIT_MARKET</code>, and <code>TRAILING_STOP_MARKET</code> orders.</p>
<h4 id="percent_price">PERCENT_PRICE<a class="headerlink" href="#percent_price" title="Permanent link">&para;</a></h4>
<blockquote>
<p><strong>/exchangeInfo format:</strong></p>
</blockquote>
<div class="highlight"><pre><span></span><code><span class="w">  </span><span class="p">{</span>
<span class="w">    </span><span class="s2">&quot;filterType&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;PERCENT_PRICE&quot;</span><span class="p">,</span>
<span class="w">    </span><span class="s2">&quot;multiplierUp&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;1.1500&quot;</span><span class="p">,</span>
<span class="w">    </span><span class="s2">&quot;multiplierDown&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;0.8500&quot;</span><span class="p">,</span>
<span class="w">    </span><span class="s2">&quot;multiplierDecimal&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">4</span>
<span class="w">  </span><span class="p">}</span>
</code></pre></div>
<p>The <code>PERCENT_PRICE</code> filter defines valid range for a price based on the mark price.</p>
<p>In order to pass the <code>percent price</code>, the following must be true for <code>price</code>:</p>
<ul>
<li>BUY: <code>price</code> &lt;= <code>markPrice</code> * <code>multiplierUp</code></li>
<li>SELL: <code>price</code> &gt;= <code>markPrice</code> * <code>multiplierDown</code></li>
</ul>
<h4 id="min_notional">MIN_NOTIONAL<a class="headerlink" href="#min_notional" title="Permanent link">&para;</a></h4>
<blockquote>
<p><strong>/exchangeInfo format:</strong></p>
</blockquote>
<div class="highlight"><pre><span></span><code><span class="w">  </span><span class="p">{</span>
<span class="w">    </span><span class="s2">&quot;filterType&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;MIN_NOTIONAL&quot;</span><span class="p">,</span>
<span class="w">    </span><span class="s2">&quot;notional&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;1&quot;</span>
<span class="w">  </span><span class="p">}</span>
</code></pre></div>
<p>The <code>MIN_NOTIONAL</code> filter defines the minimum notional value allowed for an order on a symbol.
An order's notional value is the <code>price</code> * <code>quantity</code>.
Since <code>MARKET</code> orders have no price, the mark price is used.</p>
<hr />












                
              </article>
            </div>
          
          
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
        </div>
        
          <button type="button" class="md-top md-icon" data-md-component="top" hidden>
  
  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
  Back to top
</button>
        
      </main>
      
        <footer class="md-footer">
  
  <div class="md-footer-meta md-typeset">
    <div class="md-footer-meta__inner md-grid">
      <div class="md-copyright">
  
  
    Made with
    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
      Material for MkDocs
    </a>
  
</div>
      
    </div>
  </div>
</footer>
      
    </div>
    <div class="md-dialog" data-md-component="dialog">
      <div class="md-dialog__inner md-typeset"></div>
    </div>
    
    
    
      
      
      <script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.tabs", "navigation.tabs.sticky", "navigation.sections", "navigation.top", "content.code.copy", "search.suggest", "search.highlight"], "search": "../../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
    
    
      <script src="../../assets/javascripts/bundle.79ae519e.min.js"></script>
      
    
  </body>
</html>