FxSocket API

openapi: 3.1.0
info:
  title: FxSocket API
  version: '2026-10-29'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-29: 25 operation(s) read from 8 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; FxSocket has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 3
    documentation: 22
    pages-with-code: 3
    pages-read: 8
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-29'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://fxsocket.com/docs/api/wallet
  - https://fxsocket.com/docs/api/wallet.md
  - https://fxsocket.com/docs/api/batch-orders
  - https://fxsocket.com/docs/api/batch-orders.md
  - https://fxsocket.com/sdks
  - https://fxsocket.com/docs/mt4
  - https://fxsocket.com/docs/mt5
  - https://fxsocket.com/docs/mt4.md
servers:
- url: https://api.fxsocket.com
paths:
  /AccountInfo:
    get:
      operationId: get_AccountInfo
      tags:
      - Accountinfo
      summary: Account ID API Key Endpoint
      x-source: https://fxsocket.com/docs/mt4
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /AccountSummary:
    get:
      operationId: get_AccountSummary
      tags:
      - Accountsummary
      summary: Account ID API Key Endpoint
      x-source: https://fxsocket.com/docs/mt4
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /OpenedOrders:
    get:
      operationId: get_OpenedOrders
      tags:
      - Openedorders
      summary: Account ID API Key Endpoint
      x-source: https://fxsocket.com/docs/mt4
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /OrderCalcMargin:
    get:
      operationId: get_OrderCalcMargin
      tags:
      - Ordercalcmargin
      summary: Account ID API Key Endpoint
      x-source: https://fxsocket.com/docs/mt4
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /OrderCalcProfit:
    get:
      operationId: get_OrderCalcProfit
      tags:
      - Ordercalcprofit
      summary: Calculate order profit
      x-source: https://fxsocket.com/docs/mt4
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /OrderClose:
    post:
      operationId: post_OrderClose
      tags:
      - Orderclose
      summary: Close an existing order
      x-source: https://fxsocket.com/docs/mt4
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /OrderHistory:
    get:
      operationId: get_OrderHistory
      tags:
      - Orderhistory
      summary: Account ID API Key Endpoint
      x-source: https://fxsocket.com/docs/mt4
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /OrderModify:
    post:
      operationId: post_OrderModify
      tags:
      - Ordermodify
      summary: Modify an existing order
      x-source: https://fxsocket.com/docs/mt4
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /OrderSend:
    post:
      operationId: post_OrderSend
      tags:
      - Ordersend
      summary: Place a new order
      x-source: https://fxsocket.com/docs/mt4
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /PositionHistory:
    get:
      operationId: get_PositionHistory
      tags:
      - Positionhistory
      summary: Account ID API Key Endpoint
      x-source: https://fxsocket.com/docs/mt4
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /PriceHistory:
    get:
      operationId: get_PriceHistory
      tags:
      - Pricehistory
      summary: Account ID API Key Endpoint
      x-source: https://fxsocket.com/docs/mt4
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /ServerTimezone:
    get:
      operationId: get_ServerTimezone
      tags:
      - Servertimezone
      summary: Account ID API Key Endpoint
      x-source: https://fxsocket.com/docs/mt4
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /SymbolInfo:
    get:
      operationId: get_SymbolInfo
      tags:
      - Symbolinfo
      summary: Account ID API Key Endpoint
      x-source: https://fxsocket.com/docs/mt4
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /getQuote:
    get:
      operationId: get_getQuote
      tags:
      - Getquote
      summary: Account ID API Key Endpoint
      x-source: https://fxsocket.com/docs/mt4
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /mt4/{accountid}/AccountSummary:
    get:
      operationId: get_mt4_accountid_AccountSummary
      tags:
      - Mt4
      summary: GET /mt4/{accountId}/AccountSummary
      x-source: https://fxsocket.com/docs/mt4
      parameters:
      - name: accountid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl JavaScript Copy curl -H "X-API-Key: fxs_live_YOUR_API_KEY"  "https://api.fxsocket.com/mt4/YOUR_ACCOUNT_ID/AccountSummary"
          Open in browser Swagger UI: needs account ID WS tester: needs account ID + API key Both links carry your API key in the URL so they
          open ready to use. Swagger arrives pre-authorized (and scrubs the key from the address bar); the WS tester URL keeps it and will appear
          in yo'
  /status:
    get:
      operationId: get_status
      tags:
      - Status
      summary: Account ID API Key Endpoint
      x-source: https://fxsocket.com/docs/mt4
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /symbols:
    get:
      operationId: get_symbols
      tags:
      - Symbols
      summary: Account ID API Key Endpoint
      x-source: https://fxsocket.com/docs/mt4
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/accounts:
    get:
      operationId: get_v1_accounts
      tags:
      - Accounts
      summary: List accounts
      description: 'Base URL: https://api.fxsocket.com'
      x-source: https://fxsocket.com/docs/mt4
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/orders:
    post:
      operationId: post_v1_orders
      tags:
      - Orders
      summary: Fan a single request out to several of your accounts at once, each leg with its own symbol, side, lot size and stops.
      description: Send one order to many accounts, or close across many accounts by selector, in a single call.
      x-source: https://fxsocket.com/docs/api/batch-orders
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1OrdersRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1OrdersResponse'
      x-evidence:
        kind: documentation
  /v1/orders/close:
    post:
      operationId: post_v1_orders_close
      tags:
      - Orders
      summary: Close across several accounts by intent rather than by ticket.
      description: Close positions across many accounts using a selector; resolves tickets internally.
      x-source: https://fxsocket.com/docs/api/batch-orders
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1OrdersCloseRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1OrdersCloseResponse'
      x-evidence:
        kind: documentation
  /v1/subscription:
    get:
      operationId: get_v1_subscription
      tags:
      - Subscription
      summary: Plan and status, how many account seats are paid for and how many are in use, when the current period ends, and the balance with
        whatever it owes next.
      x-source: https://fxsocket.com/docs/api/wallet
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1SubscriptionResponse'
      x-evidence:
        kind: documentation
  /v1/wallet:
    get:
      operationId: get_v1_wallet
      tags:
      - Wallet
      summary: Balance, anything asked for but not yet landed, and what the balance owes over the next 30 days.
      x-source: https://fxsocket.com/docs/api/wallet
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1WalletResponse'
      x-evidence:
        kind: documentation
  /v1/wallet/assets:
    get:
      operationId: get_v1_wallet_assets
      tags:
      - Wallet
      summary: What a top-up of this size can be paid in, one row per coin-and-chain pair, each with the asset amount that size currently costs.
      x-source: https://fxsocket.com/docs/api/wallet
      parameters:
      - name: amount_eur_cents
        in: query
        required: true
        schema:
          type: integer
        description: The top-up size, in EUR cents.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1WalletAssetsResponse'
      x-evidence:
        kind: documentation
  /v1/wallet/topup:
    post:
      operationId: post_v1_wallet_topup
      tags:
      - Wallet
      summary: Create a top-up and get the address to send to plus exactly how much of the asset to send.
      x-source: https://fxsocket.com/docs/api/wallet
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1WalletTopupRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1WalletTopupResponse'
      x-evidence:
        kind: documentation
  /v1/wallet/topup/{id}:
    get:
      operationId: get_v1_wallet_topup_id
      tags:
      - Wallet
      summary: Whether the deposit has landed.
      x-source: https://fxsocket.com/docs/api/wallet
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1WalletTopupIdResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PostV1OrdersRequest:
      type: object
      properties:
        defaults:
          type: object
          description: 'Values every leg inherits: symbol, operation, volume, price, slippage, stop_loss, take_profit, stop_limit_price, expiration,
            comment, expert_id.'
        orders:
          type: array
          description: One entry per order.
        orders[].account_id:
          type: string
          description: One of your accounts, as returned by GET /v1/accounts.
        orders[].operation:
          type: string
          description: buy, sell, buyLimit, sellLimit, buyStop, sellStop, buyStopLimit or sellStopLimit (case‑insensitive).
        orders[].volume:
          type: number
          description: Lots. Must be greater than 0.
        orders[].symbol:
          type: string
          description: Symbol for the leg, overrides defaults.
        orders[].price:
          type: number
          description: Price for the leg.
        orders[].slippage:
          type: integer
          description: Slippage for the leg.
        orders[].stop_loss:
          type: number
          description: Stop loss for the leg.
        orders[].take_profit:
          type: number
          description: Take profit for the leg.
        orders[].stop_limit_price:
          type: number
          description: Stop limit price for the leg.
        orders[].expiration:
          type: string
          description: Expiration for the leg.
        orders[].comment:
          type: string
          description: Comment for the leg.
        orders[].expert_id:
          type: string
          description: Expert ID for the leg.
      required:
      - orders
      - orders[].account_id
    PostV1OrdersResponse:
      type: object
      properties:
        batch_id:
          type: string
          description: Identifier for the batch.
        idempotent_replay:
          type: boolean
          description: Whether this response is from an idempotent replay.
        summary:
          type: object
          description: Counts of requested, filled, failed, unknown.
        results:
          type: array
          description: Per‑account results.
    PostV1OrdersCloseRequest:
      type: object
      properties:
        defaults:
          type: object
          description: 'Selector values every account inherits: symbol, symbol_match, side, kind, magic, volume, slippage.'
        accounts:
          type: array
          description: One entry per account.
        accounts[].account_id:
          type: string
          description: Account identifier.
        accounts[].symbol:
          type: string
          description: Symbol to close for this account.
        accounts[].symbol_match:
          type: string
          description: Match mode for symbol (exact or base).
        accounts[].side:
          type: string
          description: long, short, or any.
        accounts[].kind:
          type: string
          description: position, pending, or any.
        accounts[].volume:
          type: number
          description: Partial close volume.
        accounts[].tickets:
          type: array
          description: Exact tickets to close on this account.
        accounts[].require_reachable:
          type: boolean
          description: Reject batch if any account has no terminal.
      required:
      - accounts
      - accounts[].account_id
    PostV1OrdersCloseResponse:
      type: object
      properties:
        batch_id:
          type: string
          description: Identifier for the batch.
        idempotent_replay:
          type: boolean
          description: Whether this response is from an idempotent replay.
        summary:
          type: object
          description: Counts of accounts, matched, closed, failed, unknown.
        results:
          type: array
          description: Per‑account close results.
    GetV1SubscriptionResponse:
      type: object
      properties:
        plan:
          type: string
        status:
          type: string
        paid_access:
          type: boolean
        billing_provider:
          type: string
        cancel_at_period_end:
          type: boolean
        seats:
          type: object
        seat_details:
          type: array
        current_period_end:
          type: string
          description: ISO8601 datetime
        grace_ends_at:
          type: string
          description: ISO8601 datetime or null
        wallet:
          type: object
    GetV1WalletResponse:
      type: object
      properties:
        balance_eur_cents:
          type: integer
        pending_topups:
          type: array
        upcoming:
          type: array
          description: list of upcoming charges
        upcoming_total_eur_cents:
          type: integer
        shortfall_eur_cents:
          type: integer
        covers_upcoming:
          type: boolean
    GetV1WalletAssetsResponse:
      type: object
      properties:
        asset_code:
          type: string
        asset_name:
          type: string
        blockchain_code:
          type: string
        blockchain_name:
          type: string
        is_evm:
          type: boolean
        is_stable:
          type: boolean
        amount:
          type: string
        decimals:
          type: integer
        display_decimals:
          type: integer
    PostV1WalletTopupRequest:
      type: object
      properties:
        amount_eur_cents:
          type: integer
          description: €10 to €500, in cents.
        asset_code:
          type: string
          description: From GET /v1/wallet/assets, e.g. USDC.
        blockchain_code:
          type: string
          description: From the same row, e.g. ETH.
        is_evm:
          type: boolean
          description: Only for Web3 / wallet-connect flows.
      required:
      - amount_eur_cents
      - asset_code
      - blockchain_code
    PostV1WalletTopupResponse:
      type: object
      properties:
        id:
          type: integer
        status:
          type: string
        amount_eur_cents:
          type: integer
        credited_eur_cents:
          type: integer
        deposit_address:
          type: string
        deposit_amount:
          type: string
        deposit_amount_decimal:
          type: string
        asset_code:
          type: string
        blockchain_code:
          type: string
        expires_at:
          type: string
          description: ISO8601 datetime
    GetV1WalletTopupIdResponse:
      type: object
      properties:
        id:
          type: integer
        status:
          type: string
        amount_eur_cents:
          type: integer
        credited_eur_cents:
          type: integer
        deposit_address:
          type: string
        deposit_amount:
          type: string
        deposit_amount_decimal:
          type: string
        asset_code:
          type: string
        blockchain_code:
          type: string
        expires_at:
          type: string
          description: ISO8601 datetime
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
security:
- apiKey: []
tags:
- name: Accountinfo
- name: Accounts
- name: Accountsummary
- name: Getquote
- name: Mt4
- name: Openedorders
- name: Ordercalcmargin
- name: Ordercalcprofit
- name: Orderclose
- name: Orderhistory
- name: Ordermodify
- name: Orders
- name: Ordersend
- name: Positionhistory
- name: Pricehistory
- name: Servertimezone
- name: Status
- name: Subscription
- name: Symbolinfo
- name: Symbols
- name: Wallet