Binance

Binance Auto-Invest API

Auto-invest plan management and query endpoints.

GitHub OpenAPI

Documentation

📖
Documentation
https://developers.binance.com/docs/binance-spot-api-docs/rest-api
📖
Documentation
https://developers.binance.com/docs/derivatives/usds-margined-futures/general-info
📖
Documentation
https://developers.binance.com/docs/derivatives/coin-margined-futures/general-info
📖
Documentation
https://developers.binance.com/docs/derivatives/option/general-info
📖
Documentation
https://developers.binance.com/docs/derivatives/portfolio-margin/general-info
📖
Documentation
https://developers.binance.com/docs/margin_trading/general-info
📖
Documentation
https://developers.binance.com/docs/wallet/introduction
📖
Documentation
https://developers.binance.com/docs/sub_account/general-info
📖
Documentation
https://developers.binance.com/docs/simple_earn/general-info
📖
Documentation
https://developers.binance.com/docs/mining/general-info
📖
Documentation
https://developers.binance.com/docs/copy_trading/general-info
📖
Documentation
https://developers.binance.com/docs/convert/general-info
📖
Documentation
https://developers.binance.com/docs/binance-pay/introduction
📖
Documentation
https://developers.binance.com/docs/algo/general-info
📖
Documentation
https://developers.binance.com/docs/auto_invest/general-info
📖
Documentation
https://developers.binance.com/docs/crypto_loan/general-info
📖
Documentation
https://developers.binance.com/docs/gift_card/general-info
📖
Documentation
https://developers.binance.com/docs/nft/general-info
📖
Documentation
https://developers.binance.com/docs/fiat/general-info

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/binance/refs/heads/main/openapi/binance-auto-invest-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/binance/refs/heads/main/asyncapi/binance-pay-webhooks-asyncapi.yml

Other Resources

🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/binance/refs/heads/main/graphql/binance-graphql.md

OpenAPI Specification

binance-auto-invest-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Binance Algo Trading Account Auto-Invest API
  description: The Binance Algo Trading API provides access to algorithmic order execution strategies such as TWAP (Time-Weighted Average Price) and volume participation algorithms. Developers can place large orders that are automatically broken into smaller child orders and executed over time to minimize market impact.
  version: '1'
  contact:
    name: Binance Support
    url: https://www.binance.com/en/support
  termsOfService: https://www.binance.com/en/terms
servers:
- url: https://api.binance.com
  description: Production Server
security:
- apiKey: []
tags:
- name: Auto-Invest
  description: Auto-invest plan management and query endpoints.
paths:
  /sapi/v1/lending/auto-invest/target-asset/list:
    get:
      operationId: getTargetAssetList
      summary: Get target asset list
      description: Get the list of target assets available for auto-invest plans.
      tags:
      - Auto-Invest
      parameters:
      - name: targetAsset
        in: query
        schema:
          type: string
      - name: size
        in: query
        schema:
          type: integer
          default: 8
          maximum: 100
      - name: current
        in: query
        schema:
          type: integer
          default: 1
      - name: recvWindow
        in: query
        schema:
          type: integer
      - name: timestamp
        in: query
        required: true
        schema:
          type: integer
          format: int64
      - name: signature
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  targetAssets:
                    type: array
                    items:
                      type: object
                  totalSize:
                    type: integer
      security:
      - apiKey: []
        hmacSignature: []
  /sapi/v1/lending/auto-invest/source-asset/list:
    get:
      operationId: getSourceAssetList
      summary: Get source asset list
      description: Get the list of source assets that can be used for auto-invest plans.
      tags:
      - Auto-Invest
      parameters:
      - name: usageType
        in: query
        required: true
        schema:
          type: string
          enum:
          - RECURRING
          - ONE_TIME
      - name: targetAsset
        in: query
        schema:
          type: string
      - name: indexId
        in: query
        schema:
          type: integer
          format: int64
      - name: flexibleAllowedToUse
        in: query
        schema:
          type: boolean
      - name: recvWindow
        in: query
        schema:
          type: integer
      - name: timestamp
        in: query
        required: true
        schema:
          type: integer
          format: int64
      - name: signature
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
      security:
      - apiKey: []
        hmacSignature: []
  /sapi/v1/lending/auto-invest/plan/add:
    post:
      operationId: createPlan
      summary: Create auto-invest plan
      description: Create a new auto-invest plan for recurring or one-time purchases.
      tags:
      - Auto-Invest
      parameters:
      - name: sourceType
        in: query
        required: true
        schema:
          type: string
          enum:
          - MAIN_SITE
          - TR
      - name: planType
        in: query
        required: true
        schema:
          type: string
          enum:
          - SINGLE
          - PORTFOLIO
          - INDEX
      - name: subscriptionAmount
        in: query
        required: true
        schema:
          type: string
      - name: subscriptionCycle
        in: query
        required: true
        schema:
          type: string
          enum:
          - H1
          - H4
          - H8
          - H12
          - WEEKLY
          - DAILY
          - BI_WEEKLY
          - MONTHLY
      - name: subscriptionStartTime
        in: query
        schema:
          type: integer
          format: int64
      - name: sourceAsset
        in: query
        required: true
        schema:
          type: string
      - name: flexibleAllowedToUse
        in: query
        schema:
          type: boolean
      - name: details
        in: query
        description: JSON array of target asset details.
        schema:
          type: string
      - name: recvWindow
        in: query
        schema:
          type: integer
      - name: timestamp
        in: query
        required: true
        schema:
          type: integer
          format: int64
      - name: signature
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  planId:
                    type: integer
                    format: int64
                  nextExecutionDateTime:
                    type: integer
                    format: int64
      security:
      - apiKey: []
        hmacSignature: []
  /sapi/v1/lending/auto-invest/plan/edit:
    post:
      operationId: editPlan
      summary: Edit auto-invest plan
      description: Edit an existing auto-invest plan.
      tags:
      - Auto-Invest
      parameters:
      - name: planId
        in: query
        required: true
        schema:
          type: integer
          format: int64
      - name: subscriptionAmount
        in: query
        required: true
        schema:
          type: string
      - name: subscriptionCycle
        in: query
        required: true
        schema:
          type: string
      - name: sourceAsset
        in: query
        schema:
          type: string
      - name: flexibleAllowedToUse
        in: query
        schema:
          type: boolean
      - name: details
        in: query
        schema:
          type: string
      - name: recvWindow
        in: query
        schema:
          type: integer
      - name: timestamp
        in: query
        required: true
        schema:
          type: integer
          format: int64
      - name: signature
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  planId:
                    type: integer
                    format: int64
                  nextExecutionDateTime:
                    type: integer
                    format: int64
      security:
      - apiKey: []
        hmacSignature: []
  /sapi/v1/lending/auto-invest/plan/list:
    get:
      operationId: listPlans
      summary: List auto-invest plans
      description: Get the list of auto-invest plans.
      tags:
      - Auto-Invest
      parameters:
      - name: planType
        in: query
        required: true
        schema:
          type: string
          enum:
          - SINGLE
          - PORTFOLIO
          - INDEX
          - ALL
      - name: recvWindow
        in: query
        schema:
          type: integer
      - name: timestamp
        in: query
        required: true
        schema:
          type: integer
          format: int64
      - name: signature
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  planValueInUSD:
                    type: string
                  planValueInBTC:
                    type: string
                  plans:
                    type: array
                    items:
                      type: object
      security:
      - apiKey: []
        hmacSignature: []
  /sapi/v1/lending/auto-invest/history/list:
    get:
      operationId: getSubscriptionHistory
      summary: Query subscription transaction history
      description: Get auto-invest subscription transaction history.
      tags:
      - Auto-Invest
      parameters:
      - name: planId
        in: query
        schema:
          type: integer
          format: int64
      - name: startTime
        in: query
        schema:
          type: integer
          format: int64
      - name: endTime
        in: query
        schema:
          type: integer
          format: int64
      - name: targetAsset
        in: query
        schema:
          type: string
      - name: planType
        in: query
        schema:
          type: string
      - name: size
        in: query
        schema:
          type: integer
          default: 10
          maximum: 100
      - name: current
        in: query
        schema:
          type: integer
          default: 1
      - name: recvWindow
        in: query
        schema:
          type: integer
      - name: timestamp
        in: query
        required: true
        schema:
          type: integer
          format: int64
      - name: signature
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
      security:
      - apiKey: []
        hmacSignature: []
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-MBX-APIKEY
    hmacSignature:
      type: apiKey
      in: query
      name: signature
externalDocs:
  description: Binance Algo Trading Documentation
  url: https://developers.binance.com/docs/algo/general-info