openapi: 3.0.1
info:
  description: "Welcome to the official API reference for the Trading 212 Public API! This\nguide provides all the information you need to start building your own\ntrading applications and integrations.\n\n\n---\n\n# General Information\n\nThis API is currently in **beta** and is under active development. We're\ncontinuously adding new features and improvements, and we welcome your\nfeedback.\n\n\n### Only for Invest and Stocks ISA\n\nThe API described here is enabled and usable only for **Invest and Stocks ISA** account types.\n\n\n\n### API Environments\n\nWe provide two distinct environments for development and trading:\n\n* **Paper Trading (Demo):** `https://demo.trading212.com/api/v0`\n\n* **Live Trading (Real Money):** `https://live.trading212.com/api/v0`\n\nYou can test your applications extensively in the paper trading environment\nwithout risking real funds before moving to live trading.\n\n### ⚠️ API Limitations\n\nPlease be aware of the following limitations for any order placement:\n\n* **Supported account types:**  The Trading 212 Public API is enabled and\n  usable only for **Invest and Stocks ISA** account types.\n\n* **Order execution:** Orders can be executed only in the **primary account\n  currency**\n\n* **Multi-currency:** Multi-currency accounts are not currently supported\n  through the API. Meaning your account, position and result values in the\n  responses will be in the primary account currency.\n\n### Key Concepts\n\n* **Authentication:** Every request to the API must be authenticated using a\n  secure key pair. See the **Authentication** section below for details.\n\n* **Rate Limiting:** All API calls are subject to rate limits to ensure fair\n  usage and stability. See the **Rate Limiting** section for a full\n  explanation.\n\n* **IP Restrictions:** For enhanced security, you can optionally restrict\n  your API keys to a specific set of IP addresses from within your Trading 212\n  account settings.\n\n* **Selling Orders:** To execute a sell order, you must provide a\n  **negative** value for the `quantity` parameter (e.g., `-10.5`). This is a\n  core convention of the API.\n\n---\n\n## Quickstart\n\nThis simple example shows you how to retrieve your account summary.\n\nFirst, you must generate your API keys from within the Trading 212 app. For\ndetailed instructions, please visit our Help Centre:\n\n* [**How to get your Trading 212 API\n  key**](https://helpcentre.trading212.com/hc/en-us/articles/14584770928157-Trading-212-API-key)\n\nOnce you have your **API Key** and **API Secret**, you can make your first\ncall using `cURL`:\n\n```bash\n\n# Step 1: Replace with your actual credentials and Base64-encode them.\n\n# The `-n` is important as it prevents adding a newline character.\n\nCREDENTIALS=$(echo -n \"<YOUR_API_KEY>:<YOUR_API_SECRET>\" | base64)\n\n\n# Step 2: Make the API call to the live environment using the encoded\ncredentials.\n\ncurl -X GET \"https://live.trading212.com/api/v0/equity/account/summary\" \\\n -H \"Authorization: Basic $CREDENTIALS\"\n```\n\n---\n\n# Authentication\n\nThe API uses a secure key pair for authentication on every request. You must\nprovide your **API Key** as the username and your **API Secret** as the\npassword, formatted as an HTTP Basic Authentication header.\n\nThe `Authorization` header is constructed by Base64-encoding your\n`API_KEY:API_SECRET` string and prepending it with `Basic `.\n\n### Building the Authorization Header\n\nHere are examples of how to generate the required value in different\nenvironments.\n\n**Linux or macOS (Terminal)**\n\nYou can use the `echo` and `base64` commands. Remember to use the `-n` flag\nwith `echo` to prevent it from adding a trailing newline, which would\ninvalidate the credential string.\n\n```bash\n\n# This command outputs the required Base64-encoded string for your header.\n\necho -n \"<YOUR_API_KEY>:<YOUR_API_SECRET>\" | base64\n\n```\n\n**Python**\n\nThis simple snippet shows how to generate the full header value.\n\n```python\n\nimport base64\n\n\n# 1. Your credentials\n\napi_key = \"<YOUR_API_KEY>\"\n\napi_secret = \"<YOUR_API_SECRET>\"\n\n\n# 2. Combine them into a single string\n\ncredentials_string = f\"{api_key}:{api_secret}\"\n\n\n# 3. Encode the string to bytes, then Base64 encode it\n\nencoded_credentials =\nbase64.b64encode(credentials_string.encode('utf-8')).decode('utf-8')\n\n\n# 4. The final header value\n\nauth_header = f\"Basic {encoded_credentials}\"\n\n\nprint(auth_header)\n\n```\n\n---\n\n# Rate Limiting\n\nTo ensure high performance and fair access for all users, all API endpoints\nare subject to rate limiting.\n\n\n> **IMPORTANT NOTE:** All rate limits are applied on a per-account basis,\n> regardless of which API key is used or which IP address the request\n> originates from.\n\n\nSpecific rate limits are detailed in the reference for each endpoint.\n\n### Response Headers\n\nEvery API response includes the following headers to help you manage your\nrequest frequency and avoid hitting limits.\n\n* `x-ratelimit-limit`: The total number of requests allowed in the current\n  time period.\n\n* `x-ratelimit-period`: The duration of the time period in seconds.\n\n* `x-ratelimit-remaining`: The number of requests you have left in the\n  current period.\n\n* `x-ratelimit-reset`: A Unix timestamp indicating the exact time when the\n  limit will be fully reset.\n\n* `x-ratelimit-used`: The number of requests you have already made in the\n  current period.\n\n### How It Works\n\nThe rate limiter allows for requests to be made in bursts. For example, an\nendpoint with a limit of `50 requests per 1 minute` does **not** strictly\nmean you can only make one request every 1.2 seconds. Instead, you could:\n\n* Make a burst of all 50 requests in the first 5 seconds of a minute. You\n  would then need to wait for the reset time indicated by the\n  `x-ratelimit-reset` header before making more requests.\n\n* Pace your requests evenly, for example, by making one call every 1.2\n  seconds, ensuring you always stay within the limit.\n\n### Function-Specific Limits\n\nIn addition to the general rate limits on HTTP calls, some actions have\ntheir own functional limits. For example, there is a maximum of **50 pending\norders** allowed per ticker, per account.\n\n# Pagination\n\nAll list endpoints in the API that return a collection of items (such as historical orders, dividends, and transactions) use **cursor-based pagination** to handle large data sets.\n\n### Parameters\n\n* **`limit`** (integer): Specifies the maximum number of items to return in a single request.\n  * **Default:** 20\n  * **Maximum:** 50\n* **`cursor`** (string | number): A pointer to a specific item in the dataset. This tells the API where to start the next page of results.\n\n### How to Paginate\n\nThe easiest way to paginate is by using the `nextPagePath` field returned in the response.\n\n1.  Make your initial request to a list endpoint (e.g., `/api/v0/equity/history/orders`) with an optional `limit` parameter. Do not include a `cursor`.\n2.  The API will return a response object. This object will contain a list of `items` and a `nextPagePath` field.\n3.  If the `nextPagePath` field is `null`, you have reached the end of the data, and there are no more pages.\n4.  If `nextPagePath` is not `null`, **use the entire string value of `nextPagePath`** as the path for your next request. This string contains all the necessary parameters (like `limit` and `cursor`) to get the next page.\n5.  Repeat this process until `nextPagePath` is `null`.\n\n### Example\n\nHere is a step-by-step example of fetching all transactions, 2 at a time.\n\n**Request 1: Get the first page**\n```bash\ncurl -X GET \"https://demo.trading212.com/api/v0/equity/history/orders?limit=2\" \\\n     -u \"API_KEY:API_SECRET\"\n```\n**Response 1: Note the nextPagePath**\n```json\n{\n  \"items\": [\n    { \"id\": 987654321, \"ticker\": \"AAPL_US_EQ\", ... },\n    { \"id\": 987654320, \"ticker\": \"MSFT_US_EQ\", ... }\n  ],\n  \"nextPagePath\": \"/api/v0/equity/history/orders?limit=2&cursor=1760346100000\"\n}\n```\n**Request 2: Use the full nextPagePath for the next request**\n```bash\ncurl -X GET \"https://demo.trading212.com/api/v0/equity/history/orders?limit=2&cursor=1760346100000\" \\\n     -u \"API_KEY:API_SECRET\"\n```\n**Response 2: Get the next page (and a new nextPagePath)**\n```json\n{\n  \"items\": [\n    { \"id\": 987654319, \"ticker\": \"AAPL_US_EQ\", ... },\n    { \"id\": 987654320, \"987654318\": \"MSFT_US_EQ\", ... }\n  ],\n  \"nextPagePath\": \"/api/v0/equity/history/orders?limit=2&cursor=1660015723000\"\n}\n```\n**Request 3: Get the final page**\n```bash\ncurl -X GET \"https://demo.trading212.com/api/v0/equity/history/orders?limit=2&cursor=1660015723000\" \\\n     -u \"API_KEY:API_SECRET\"\n```\nResponse 3: nextPagePath is null, indicating the end\n```json\n{\n  \"items\": [\n    { \"id\": 987654317, \"ticker\": \"AMZN_US_EQ\", ... }\n  ],\n  \"nextPagePath\": null\n}\n```\n\n---\n\n# Useful Links\n\nHere are some additional resources that you may find helpful.\n\n* [**Trading 212 API\n  Terms**](https://www.trading212.com/legal-documentation/API-Terms_EN.pdf)\n\n* [**Trading 212 Community Forum**](https://community.trading212.com/) - A\n  great place to ask questions and share what you've built.\n"
  title: Trading 212 Public Accounts Orders API
  version: v0
servers:
- url: https://demo.trading212.com
- url: https://live.trading212.com
tags:
- description: '**⚠️ Order Limitations**


    * Orders can be executed only in the **main account currency**



    Place, monitor, and cancel equity trade orders. This section provides the

    core functionality for programmatically executing your trading strategies

    for stocks and ETFs.'
  name: Orders
paths:
  /api/v0/equity/orders:
    get:
      description: 'Retrieves a list of all orders that are currently active (i.e., not yet

        filled, cancelled, or expired). This is useful for monitoring the status

        of your open positions and managing your trading strategy.


        **Rate limit:** 1 req / 5s'
      operationId: orders
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Order'
                type: array
          description: OK
        '401':
          description: Bad API key
        '403':
          description: Scope( orders:read ) missing for API key
        '408':
          description: Timed-out
        '429':
          description: 'Limited: 1 / 5s'
      security:
      - authWithSecretKey: []
        legacyApiKeyHeader: []
      summary: Get all pending orders
      tags:
      - Orders
  /api/v0/equity/orders/limit:
    post:
      description: 'Creates a new Limit order, which executes at a specified price or

        better.


        - To place a **buy** order, use a positive `quantity`. The order will

        fill at the `limitPrice` or lower.


        - To place a **sell** order, use a negative `quantity`. The order will

        fill at the `limitPrice` or higher.




        **Order Limitations**


        * Orders can be executed only in the **main account currency**



        **Important:** In this beta version, this endpoint is **not

        idempotent**. Sending the same request multiple times may result in

        duplicate orders.


        **Rate limit:** 1 req / 2s'
      operationId: placeLimitOrder
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LimitRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
          description: OK
        '400':
          description: Failed validation
        '401':
          description: Bad API key
        '403':
          description: Scope( orders:execute ) missing for API key
        '408':
          description: Timed-out
        '429':
          description: 'Limited: 1 / 2s'
      security:
      - authWithSecretKey: []
        legacyApiKeyHeader: []
      summary: Place a Limit order
      tags:
      - Orders
  /api/v0/equity/orders/market:
    post:
      description: "Creates a new Market order, which is an instruction to trade a security\nimmediately at the next available price. \n\n- To place a **buy** order, use a positive `quantity`. \n\n- To place a **sell** order, use a negative `quantity`.\n\n\n- **`extendedHours`**: Set to `true` to allow the order to be filled\noutside of the standard trading session.\n\n- If placed when the market is closed, the order will be queued to\nexecute when the market next opens.\n\nx\n**Order Limitations**\n\n* Orders can be executed only in the **main account currency**\n\n\n**Warning:** Market orders can be subject to price slippage, where the\nfinal execution price may differ from the price at the time of order\nplacement.\n\n\n**Important:** In this beta version, this endpoint is **not\nidempotent**. Sending the same request multiple times may result in\nduplicate orders.\n\n**Rate limit:** 50 req / 1m0s"
      operationId: placeMarketOrder
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MarketRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
          description: OK
        '400':
          description: Failed validation
        '401':
          description: Bad API key
        '403':
          description: Scope( orders:execute ) missing for API key
        '408':
          description: Timed-out
        '429':
          description: 'Limited: 50 / 1m0s'
      security:
      - authWithSecretKey: []
        legacyApiKeyHeader: []
      summary: Place a Market order
      tags:
      - Orders
  /api/v0/equity/orders/stop:
    post:
      description: 'Creates a new Stop order, which places a Market order once the

        `stopPrice` is reached.


        - To place a **buy** stop order, use a positive `quantity`.


        - To place a **sell** stop order (commonly a ''stop-loss''), use a

        negative `quantity`.



        - The `stopPrice` is triggered by the instrument''s **Last Traded Price

        (LTP)**.





        **Order Limitations**


        * Orders can be executed only in the **main account currency**


        **Important:** In this beta version, this endpoint is **not

        idempotent**. Sending the same request multiple times may result in

        duplicate orders.


        **Rate limit:** 1 req / 2s'
      operationId: placeStopOrder_1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StopRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
          description: OK
        '400':
          description: Failed validation
        '401':
          description: Bad API key
        '403':
          description: Scope( orders:execute ) missing for API key
        '408':
          description: Timed-out
        '429':
          description: 'Limited: 1 / 2s'
      security:
      - authWithSecretKey: []
        legacyApiKeyHeader: []
      summary: Place a Stop order
      tags:
      - Orders
  /api/v0/equity/orders/stop_limit:
    post:
      description: 'Creates a new Stop-Limit order, combining features of a Stop and a Limit

        order. The direction of the trade (buy/sell) is determined by the sign

        of the `quantity` field.



        **Execution Logic:**


        1.  When the instrument''s **Last Traded Price (LTP)** reaches the

        specified `stopPrice`, the order is triggered.


        2.  A Limit order is then automatically placed at the specified

        `limitPrice`.



        This two-step process helps protect against price slippage that can

        occur with a standard Stop order.



        **Order Limitations**


        * Orders can be executed only in the **main account currency**



        **Important:** In this beta version, this endpoint is **not

        idempotent**. Sending the same request multiple times may result in

        duplicate orders.


        **Rate limit:** 1 req / 2s'
      operationId: placeStopOrder
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StopLimitRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
          description: OK
        '400':
          description: Failed validation
        '401':
          description: Bad API key
        '403':
          description: Scope( orders:execute ) missing for API key
        '408':
          description: Timed-out
        '429':
          description: 'Limited: 1 / 2s'
      security:
      - authWithSecretKey: []
        legacyApiKeyHeader: []
      summary: Place a StopLimit order
      tags:
      - Orders
  /api/v0/equity/orders/{id}:
    delete:
      description: 'Attempts to cancel an active, unfilled order by its unique ID.

        Cancellation is not guaranteed if the order is already in the process of

        being filled. A successful response indicates the cancellation request

        was accepted.


        **Rate limit:** 50 req / 1m0s'
      operationId: cancelOrder
      parameters:
      - description: The unique identifier of the order you want to cancel.
        in: path
        name: id
        required: true
        schema:
          format: int64
          type: integer
      responses:
        '200':
          description: OK
        '400':
          description: Failed validation
        '401':
          description: Bad API key
        '403':
          description: Scope( orders:execute ) missing for API key
        '404':
          description: Order not found
        '408':
          description: Timed-out
        '429':
          description: 'Limited: 50 / 1m0s'
      security:
      - authWithSecretKey: []
        legacyApiKeyHeader: []
      summary: Cancel a pending order
      tags:
      - Orders
    get:
      description: 'Retrieves a single pending order using its unique numerical ID. This is

        useful for checking the status of a specific order you have previously

        placed.


        **Rate limit:** 1 req / 1s'
      operationId: orderById
      parameters:
      - description: The unique identifier of the order you want to retrieve.
        in: path
        name: id
        required: true
        schema:
          format: int64
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
          description: Order found
        '401':
          description: Bad API key
        '403':
          description: Scope( orders:read ) missing for API key
        '404':
          description: Order not found
        '408':
          description: Timed-out
        '429':
          description: 'Limited: 1 / 1s'
      security:
      - authWithSecretKey: []
        legacyApiKeyHeader: []
      summary: Get a pending order by ID
      tags:
      - Orders
components:
  schemas:
    LimitRequest:
      properties:
        limitPrice:
          example: 100.23
          type: number
        quantity:
          example: 0.1
          type: number
        ticker:
          example: AAPL_US_EQ
          type: string
        timeValidity:
          $ref: '#/components/schemas/TimeValidity'
          description: Expiration
          example: DAY
      type: object
    Instrument:
      description: Instrument information as given by /instruments endpoint.
      properties:
        currency:
          description: Instrument currency in ISO 4217 format.
          type: string
        isin:
          description: ISIN of the instrument.
          type: string
        name:
          description: Name of the instrument.
          type: string
        ticker:
          description: Unique instrument identifier.
          example: AAPL_US_EQ
          type: string
      type: object
    TimeValidity:
      description: "Specifies how long the order remains active: \n* DAY: The order will automatically expire if not executed by midnight in the time zone of the instrument's exchange.\n* GOOD_TILL_CANCEL: The order remains active indefinitely until it is either filled or explicitly cancelled by you."
      enum:
      - DAY
      - GOOD_TILL_CANCEL
      type: string
    Order:
      properties:
        createdAt:
          description: The ISO 8601 formatted date of when the order was created.
          format: date-time
          type: string
        currency:
          description: The currency used for the order in ISO 4217 format.
          type: string
        extendedHours:
          description: If true, the order is eligible for execution outside regular trading hours.
          type: boolean
        filledQuantity:
          description: The number of shares that have been successfully executed. Applicable to quantity orders.
          type: number
        filledValue:
          description: 'The total monetary value of the executed portion of the order. Applicable to orders placed by value.Note: Placing orders by value is not currently supported via the API but can be done through other Trading 212 platforms.'
          type: number
        id:
          description: A unique, system-generated identifier for the order.
          format: int64
          type: integer
        initiatedFrom:
          description: How the order was initiated.
          enum:
          - API
          - IOS
          - ANDROID
          - WEB
          - SYSTEM
          - AUTOINVEST
          - INSTRUMENT_AUTOINVEST
          type: string
        instrument:
          $ref: '#/components/schemas/Instrument'
        limitPrice:
          description: Applicable to LIMIT and STOP_LIMIT orders.
          type: number
        quantity:
          description: The total number of shares requested. Applicable to quantity orders.
          type: number
        side:
          description: Indicates whether the order is BUY or SELL.
          enum:
          - BUY
          - SELL
          type: string
        status:
          description: The current state of the order in its lifecycle.
          enum:
          - LOCAL
          - UNCONFIRMED
          - CONFIRMED
          - NEW
          - CANCELLING
          - CANCELLED
          - PARTIALLY_FILLED
          - FILLED
          - REJECTED
          - REPLACING
          - REPLACED
          type: string
        stopPrice:
          description: Applicable to STOP and STOP_LIMIT orders.
          type: number
        strategy:
          description: The strategy used to place the order, either by QUANTITY or VALUE. The API currently only supports placing orders by QUANTITY.
          enum:
          - QUANTITY
          - VALUE
          type: string
        ticker:
          description: Unique instrument identifier. Get from the /instruments endpoint
          example: AAPL_US_EQ
          type: string
        timeInForce:
          $ref: '#/components/schemas/TimeValidity'
        type:
          enum:
          - LIMIT
          - STOP
          - MARKET
          - STOP_LIMIT
          type: string
        value:
          description: The total monetary value of the order. Applicable to value orders.
          type: number
      type: object
    MarketRequest:
      properties:
        extendedHours:
          default: false
          example: true
          type: boolean
        quantity:
          example: 0.1
          type: number
        ticker:
          example: AAPL_US_EQ
          type: string
      type: object
    StopRequest:
      properties:
        quantity:
          example: 0.1
          type: number
        stopPrice:
          example: 100.23
          type: number
        ticker:
          example: AAPL_US_EQ
          type: string
        timeValidity:
          $ref: '#/components/schemas/TimeValidity'
          description: Expiration
          example: DAY
      type: object
    StopLimitRequest:
      properties:
        limitPrice:
          example: 100.23
          type: number
        quantity:
          example: 0.1
          type: number
        stopPrice:
          example: 100.23
          type: number
        ticker:
          example: AAPL_US_EQ
          type: string
        timeValidity:
          $ref: '#/components/schemas/TimeValidity'
          description: Expiration
          example: DAY
      type: object
  securitySchemes:
    authWithSecretKey:
      description: Use your API Key as the username and your API Secret as the password
      scheme: basic
      type: http
    legacyApiKeyHeader:
      in: header
      name: Authorization
      type: apiKey