> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bullionwale.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Trading limits (test)

> **Available on request.** Ask the Bullionwale desk to turn on API access for your account and issue a test key. Test orders are simulated; nothing is booked.

Your real weight allocation per metal, with `used`, `free` and `reserved` measured on your TEST book (your test orders and test limit orders): `free` is the room a test order has. Gold in grams, silver in kilograms.



## OpenAPI

````yaml /openapi.json get /api/trading/test/v1/limits
openapi: 3.1.0
info:
  description: >-
    Place and read bullion orders with an API key. The test environment
    (`/api/trading/test/v1`) simulates orders; the production environment
    (`/api/trading/v1`) books real orders. **Test: available on request.
    Production: switched off.** See the availability notice in the
    documentation.
  title: Bullionwale API
  version: 1.0.0
servers:
  - description: Once the API is available
    url: https://api.bullionwale.com
security: []
tags:
  - description: >-
      The account and API key behind a request, the key's scopes, and whether
      production trading is available to the account.
    name: Account
  - description: >-
      Your live Buy and Sell rates per symbol, with freshness and trading flags.
      The same prices on test and production.
    name: Market data
  - description: >-
      The symbols you can trade: metal, price and quantity units, the sizes you
      may order and which sides are offered.
    name: Symbols
  - description: >-
      Whether trading is halted, which symbols are frozen, the market clock and
      your rates at the latest official close.
    name: Market status
  - description: >-
      Your weight allocation per metal and how much of it your open position
      uses.
    name: Trading limits
  - description: >-
      Realized profit and loss from your closed orders, in total, per symbol and
      per day.
    name: Profit & loss
  - description: >-
      Place market orders, list them and read one. Test orders are simulated;
      production orders are real.
    name: Orders
  - description: >-
      Place a buy or sell limit that waits for a price, list your limits, read,
      edit and cancel one. Test limits are simulated and never execute;
      production limits are real.
    name: Limit orders
  - description: Your net position per metal against your weight allocation.
    name: Positions
  - description: Your physical-delivery requests and their status.
    name: Deliveries
  - description: >-
      Your API keys in the calling environment: ids, names, scopes, state. Never
      a secret.
    name: API keys
  - description: >-
      Register HTTPS endpoints that receive signed order and limit-order events,
      test them and rotate their signing secret. Not yet available.
    name: Webhooks
paths:
  /api/trading/test/v1/limits:
    get:
      tags:
        - Trading limits
      summary: Trading limits (test)
      description: >-
        **Available on request.** Ask the Bullionwale desk to turn on API access
        for your account and issue a test key. Test orders are simulated;
        nothing is booked.


        Your real weight allocation per metal, with `used`, `free` and
        `reserved` measured on your TEST book (your test orders and test limit
        orders): `free` is the room a test order has. Gold in grams, silver in
        kilograms.
      operationId: limits_test_api_trading_test_v1_limits_get
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Limits'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            `missing_credential`: No X-API-Key header.

            `malformed_credential`: The key is not shaped like an API key.

            `wrong_tenant`: The key belongs to a different broker.

            `wrong_environment`: A test key on the production API, or the
            reverse.

            `invalid_credential`: Unknown key or wrong secret.

            `credential_revoked`: The key was revoked.

            `credential_rotated`: The key was replaced and its overlap period
            ended.

            `credential_expired`: The key expired.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: |-
            `api_access_disabled`: API access is switched off for this account.
            `account_inactive`: The account is not active.
            `insufficient_scope`: The key lacks the scope this route needs.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            `invalid_request`: The request body or parameters are invalid; see
            `detail.errors`.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            `auth_throttled`: Too many failed authentications from this address;
            see Retry-After.

            `rate_limited`: This key (or, for orders, this account) exhausted
            its budget; see Retry-After.
      security:
        - ApiKeyAuth: []
components:
  schemas:
    Limits:
      properties:
        gold:
          $ref: '#/components/schemas/MetalLimit'
        silver:
          $ref: '#/components/schemas/MetalLimit'
      required:
        - gold
        - silver
      title: Limits
      type: object
    ApiError:
      description: Every refusal on the trading API.
      properties:
        detail:
          $ref: '#/components/schemas/ApiErrorDetail'
      required:
        - detail
      title: ApiError
      type: object
    MetalLimit:
      properties:
        free:
          description: '`limit` minus `used`, never below zero.'
          title: Free
          type: string
        limit:
          description: Your allocation, in `unit`, as a decimal string.
          title: Limit
          type: string
        reserved:
          description: >-
            What your resting limit orders would need if they all triggered.
            Shown for planning; it is not deducted from `free`.
          title: Reserved
          type: string
        unit:
          description: '`g` for gold, `kg` for silver.'
          title: Unit
          type: string
        used:
          description: Your open net position (buys minus sells), in `unit`.
          title: Used
          type: string
      required:
        - limit
        - used
        - free
        - reserved
        - unit
      title: MetalLimit
      type: object
    ApiErrorDetail:
      additionalProperties: true
      properties:
        code:
          description: Stable machine code; branch on this, not on `message`.
          title: Code
          type: string
        message:
          description: Human-readable text; may change.
          title: Message
          type: string
      required:
        - code
        - message
      title: ApiErrorDetail
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-API-Key
      type: apiKey

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.