WOO X

WOO X Account API

The Account API from WOO X — 9 operation(s) for account.

GitHub OpenAPI

Operations 9

GET /v3/account/referral/summary Get account referral summary #
GET /v3/account/referral/rewardHistory Get account referral reward history #
GET /v3/account/tokenConfig Get account token config #
GET /v3/account/symbolConfig Get account symbol config #
GET /v3/account/info Get account info #
POST /v3/account/tradingMode Create account trading mode #
GET /v3/account/credentials Get account credentials #
GET /v3/account/subAccounts/all Get account sub accounts all #
POST /v3/account/listenKey Create account listen key #

Documentation

📖
APIReference
https://developer.woox.io/api-reference

Specifications

⚙
OpenAPI
https://artifacts.apis.io/woox/openapi/woox-account-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/woox/json-schema/woox-get-algo-order-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/woox/json-schema/woox-wallet-history-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/woox/json-schema/woox-account-info-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/woox/json-schema/woox-create-order-schema.json
📊
JSONSchema
https://artifacts.apis.io/woox/json-schema/woox-stop-bracket-stop-bracket-schema.json
📊
JSONSchema
https://artifacts.apis.io/woox/json-schema/woox-get-balances-response-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/woox:woox-account-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

woox-account-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Swagger Petstore - OpenAPI 3.0 Account API
  description: This is a sample Pet Store Server based on the OpenAPI 3.0 specification.
  termsOfService: http://swagger.io/terms/
  contact:
    name: API Team
    email: apiteam@swagger.io
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.0.19
servers:
- url: https://api.woox.io/
tags:
- name: Account
paths:
  /v3/account/referral/summary:
    get:
      description: Get referral information from each user you has referred
      parameters:
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
          example: abcdef123456
        description: ''
      - name: x-api-signature
        in: header
        required: true
        schema:
          type: string
          example: signaturestring
        description: ''
      - name: x-api-timestamp
        in: header
        required: true
        schema:
          type: string
          example: '1718943200000'
        description: ''
      - name: startTime
        in: query
        description: start time in unix timestamp
        required: false
        explode: true
        schema:
          type: integer
      - name: endTime
        in: query
        description: end time in unix timestamp
        required: false
        explode: true
        schema:
          type: integer
      - name: page
        in: query
        description: the page you wish to query.
        required: false
        explode: true
        schema:
          type: integer
          default: 1
      - name: size
        in: query
        description: the page size you wish to query, default = 25, 1000 at max.
        required: false
        explode: true
        schema:
          type: integer
          default: 25
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferralResponse'
      security: []
      tags:
      - Account
      summary: Get account referral summary
      x-summary-source: derived
      operationId: getV3AccountReferralSummary
      x-operation-id-source: derived
  /v3/account/referral/rewardHistory:
    get:
      description: Get referral information from each user you has referred.
      parameters:
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
          example: abcdef123456
        description: ''
      - name: x-api-signature
        in: header
        required: true
        schema:
          type: string
          example: signaturestring
        description: ''
      - name: x-api-timestamp
        in: header
        required: true
        schema:
          type: string
          example: '1718943200000'
        description: ''
      - name: startTime
        in: query
        description: start time in unix timestamp
        required: false
        explode: true
        schema:
          type: integer
      - name: endTime
        in: query
        description: end time in unix timestamp
        required: false
        explode: true
        schema:
          type: integer
      - name: page
        in: query
        description: the page you wish to query.
        required: false
        explode: true
        schema:
          type: integer
          default: 1
      - name: size
        in: query
        description: the page size you wish to query, default = 25, 1000 at max.
        required: false
        explode: true
        schema:
          type: integer
          default: 25
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferralResponse'
      security: []
      tags:
      - Account
      summary: Get account referral reward history
      x-summary-source: derived
      operationId: getV3AccountReferralRewardHistory
      x-operation-id-source: derived
  /v3/account/tokenConfig:
    get:
      description: Get the token level configurations.
      parameters:
      - $ref: '#/components/parameters/ApiKeyHeader'
      - $ref: '#/components/parameters/SignatureHeader'
      - $ref: '#/components/parameters/TimestampHeader'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TokenConfigResponse'
      security: []
      tags:
      - Account
      summary: Get account token config
      x-summary-source: derived
      operationId: getV3AccountTokenConfig
      x-operation-id-source: derived
  /v3/account/symbolConfig:
    get:
      description: Get the symbol level configurations.
      parameters:
      - $ref: '#/components/parameters/ApiKeyHeader'
      - $ref: '#/components/parameters/SignatureHeader'
      - $ref: '#/components/parameters/TimestampHeader'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SymbolConfigResponse'
      security: []
      tags:
      - Account
      summary: Get account symbol config
      x-summary-source: derived
      operationId: getV3AccountSymbolConfig
      x-operation-id-source: derived
  /v3/account/info:
    get:
      description: Get the account information.
      parameters:
      - $ref: '#/components/parameters/ApiKeyHeader'
      - $ref: '#/components/parameters/SignatureHeader'
      - $ref: '#/components/parameters/TimestampHeader'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountInfoResponse'
      security: []
      tags:
      - Account
      summary: Get account info
      x-summary-source: derived
      operationId: getV3AccountInfo
      x-operation-id-source: derived
  /v3/account/tradingMode:
    post:
      description: Set account trading mode
      parameters:
      - $ref: '#/components/parameters/ApiKeyHeader'
      - $ref: '#/components/parameters/SignatureHeader'
      - $ref: '#/components/parameters/TimestampHeader'
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetTradingMode'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
      security: []
      tags:
      - Account
      summary: Create account trading mode
      x-summary-source: derived
      operationId: postV3AccountTradingMode
      x-operation-id-source: derived
  /v3/account/credentials:
    get:
      description: Get account api key permission
      parameters:
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
          example: abcdef123456
        description: ''
      - name: x-api-signature
        in: header
        required: true
        schema:
          type: string
          example: signaturestring
        description: ''
      - name: x-api-timestamp
        in: header
        required: true
        schema:
          type: string
          example: '1718943200000'
        description: ''
      - name: page
        in: query
        description: the page you wish to query.
        required: false
        explode: true
        schema:
          type: integer
          default: 1
      - name: size
        in: query
        description: the page size you wish to query, default = 25, 1000 at max.
        required: false
        explode: true
        schema:
          type: integer
          default: 25
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialsResponse'
      security: []
      tags:
      - Account
      summary: Get account credentials
      x-summary-source: derived
      operationId: getV3AccountCredentials
      x-operation-id-source: derived
  /v3/account/subAccounts/all:
    get:
      description: Get account api key permission
      parameters:
      - $ref: '#/components/parameters/ApiKeyHeader'
      - $ref: '#/components/parameters/SignatureHeader'
      - $ref: '#/components/parameters/TimestampHeader'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubAccountsResponse'
      security: []
      tags:
      - Account
      summary: Get account sub accounts all
      x-summary-source: derived
      operationId: getV3AccountSubAccountsAll
      x-operation-id-source: derived
  /v3/account/listenKey:
    post:
      description: get account listen key
      parameters:
      - $ref: '#/components/parameters/ApiKeyHeader'
      - $ref: '#/components/parameters/SignatureHeader'
      - $ref: '#/components/parameters/TimestampHeader'
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetListenKey'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListenKeyResponse'
      security: []
      tags:
      - Account
      summary: Create account listen key
      x-summary-source: derived
      operationId: postV3AccountListenKey
      x-operation-id-source: derived
components:
  schemas:
    GetListenKey:
      required:
      - type
      type: object
      properties:
        type:
          type: string
          description: WEBSOCKET
          example: WEBSOCKET
    AccountInfoResponse:
      allOf:
      - $ref: '#/components/schemas/CommonResponse'
      - type: object
        properties:
          data:
            type: object
            properties:
              applicationId:
                type: string
                description: The ID of the application associated with the account.
              account:
                type: string
                description: The account identifier.
              alias:
                type: string
                description: Alias name for the account.
              otpauth:
                type: boolean
                description: Indicates whether OTP authentication is enabled for the account.
              accountMode:
                type: string
                description: The account mode, e.g., 'MARGIN'.
                enum:
                - MARGIN
                - SPOT
              positionMode:
                type: string
                description: Position mode of the account, e.g., 'ONE_WAY'.
                enum:
                - ONE_WAY
                - HEDGE_MODE
              leverage:
                type: integer
                description: The leverage level set for the account.
              marginRatio:
                type: string
                description: The margin ratio of the account.
              openMarginRatio:
                type: string
                description: The open margin ratio of the account.
              initialMarginRatio:
                type: string
                description: The initial margin ratio of the account.
              maintenanceMarginRatio:
                type: string
                description: The maintenance margin ratio of the account.
              totalCollateral:
                type: string
                description: The total collateral value of the account.
              freeCollateral:
                type: string
                description: The free collateral value of the account.
              totalAccountValue:
                type: string
                description: The total account value.
              totalTradingValue:
                type: string
                description: The total trading value of the account.
              totalVaultValue:
                type: string
                description: The total vault value of the account.
              totalStakingValue:
                type: string
                description: The total staking value of the account.
              totalEarnValue:
                type: string
                description: The total value earned by the account.
              totalLaunchpadValue:
                type: string
                description: The total launchpad value of the account.
              referrerID:
                type: string
                description: The ID of the referrer associated with the account.
              accountType:
                type: string
                description: The type of the account, e.g., 'Main'.
                enum:
                - Main
                - Sub
    ListenKeyResponse:
      allOf:
      - $ref: '#/components/schemas/CommonResponse'
      - type: object
        properties:
          data:
            type: object
            properties:
              authKey:
                type: string
                description: listenKey
              expiredTime:
                type: integer
                description: ''
    SubAccountsResponse:
      allOf:
      - $ref: '#/components/schemas/CommonResponse'
      - type: object
        properties:
          data:
            type: object
            properties:
              rows:
                type: array
                items:
                  type: object
                  properties:
                    applicationId:
                      type: string
                      description: The unique identifier for the application.
                    name:
                      type: string
                      description: The name of the application or sub-account.
                    createdTime:
                      type: string
                      description: The time the application was created, represented as a Unix timestamp in seconds with millisecond precision.
    ReferralResponse:
      allOf:
      - $ref: '#/components/schemas/CommonResponse'
      - type: object
        properties:
          data:
            type: object
            properties:
              rows:
                type: array
                items:
                  type: object
                  properties:
                    referralId:
                      type: integer
                      description: Referral ID
                    registerTime:
                      type: string
                      description: Time the referral was registered
                    referralCode:
                      type: string
                      description: Referral code
                    tradeStatus:
                      type: string
                      description: Status of the trade
                    earned:
                      type: array
                      items:
                        type: object
                        properties:
                          token:
                            type: string
                            description: Token type
                          amount:
                            type: string
                            description: Amount earned
                    extraBonus:
                      type: array
                      items:
                        type: object
                        properties:
                          token:
                            type: string
                            description: Token type
                          amount:
                            type: string
                            description: Amount earned
                    previousCommission:
                      type: array
                      items:
                        type: object
                        properties:
                          token:
                            type: string
                            description: Token type
                          totalAmount:
                            type: string
                            description: Amount earned
                    email:
                      type: string
                      description: Email address
              meta:
                $ref: '#/components/schemas/Meta'
    CredentialsResponse:
      allOf:
      - $ref: '#/components/schemas/CommonResponse'
      - type: object
        properties:
          data:
            type: object
            properties:
              rows:
                type: array
                items:
                  type: object
                  properties:
                    accountName:
                      type: string
                      description: The account name associated with the API key, e.g., 'Main'.
                    userId:
                      type: integer
                      description: The unique identifier of the user associated with the API key.
                    apiKey:
                      type: string
                      description: The API key used for authentication.
                    permissions:
                      type: array
                      items:
                        type: string
                        enum:
                        - READ
                        - TRADE
                        - WITHDRAWAL
                      description: The permissions assigned to the API key, e.g., 'READ', 'TRADE', 'WITHDRAWAL'.
                    allowedIPs:
                      type: array
                      items:
                        type: string
                        format: ipv4
                      description: A list of IP addresses allowed to use this API key. This field may be hidden if there is no IP restriction.
              meta:
                $ref: '#/components/schemas/Meta'
    SetTradingMode:
      required:
      - tradingMode
      type: object
      properties:
        tradingMode:
          type: string
          description: PURE_SPOT/MARGIN/FUTURES
          example: PURE_SPOT
    Meta:
      type: object
      properties:
        total:
          type: integer
          description: Total number of record
        recordsPerPage:
          type: integer
          description: Number of records per page
        currentPage:
          type: integer
          description: Current page number
    SymbolConfigResponse:
      allOf:
      - $ref: '#/components/schemas/CommonResponse'
      - type: object
        properties:
          data:
            type: object
            properties:
              rows:
                type: array
                items:
                  type: object
                  properties:
                    symbol:
                      type: string
                      description: Trading pair symbol, e.g., PERP_BTC_USDT.
                    marginFactor:
                      type: string
                      description: Margin factor for the trading pair, represented as a string for precision.
                    maxLeverage:
                      type: integer
                      description: Maximum leverage allowed for this trading pair.
                    maxPosition:
                      type: integer
                      description: Maximum position size allowed for this trading pair.
    TokenConfigResponse:
      allOf:
      - $ref: '#/components/schemas/CommonResponse'
      - type: object
        properties:
          data:
            type: object
            properties:
              rows:
                type: array
                items:
                  type: object
                  properties:
                    token:
                      type: string
                      description: Token symbol, e.g., BTC.
                    collateralRatio:
                      type: string
                      description: The collateral ratio of the token, represented as a string.
                    marginFactor:
                      type: string
                      description: The margin factor of the token, represented as a string for precision.
                    collateral:
                      type: boolean
                      description: Indicates if the token is currently being used as collateral.
                    canCollateral:
                      type: boolean
                      description: Indicates if the token can be used as collateral.
                    canShort:
                      type: boolean
                      description: Indicates if short selling is supported for the token.
                    marginMaxLeverage:
                      type: integer
                      description: Maximum leverage allowed for margin trading.
                    marginMaxPosition:
                      type: integer
                      description: Maximum allowed position size for the token in margin trading.
    CommonResponse:
      type: object
      properties:
        success:
          type: boolean
          description: 'true'
        timestamp:
          type: integer
          description: timestamp
  parameters:
    SignatureHeader:
      name: x-api-signature
      in: header
      required: true
      schema:
        type: string
        example: signaturestring
      description: api-signature
    TimestampHeader:
      name: x-api-timestamp
      in: header
      required: true
      schema:
        type: string
        example: '1718943200000'
      description: api-timestamp
    ApiKeyHeader:
      name: x-api-key
      in: header
      required: true
      schema:
        type: string
        example: abcdef123456
      description: api-key
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    api_key:
      type: apiKey
      name: api_keyqq
      in: header
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
    ApiSignAuth:
      type: apiKey
      in: header
      name: x-api-signature
    ApiTimestampAuth:
      type: apiKey
      in: header
      name: x-api-timestamp
externalDocs:
  description: Find out more about Swagger
  url: http://swagger.io
x-provenance:
  method: harvested
  publisher: WOO X
  source: https://developer.woox.io/openapi-merged.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)