> ## 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.

# Test positions

> **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.

The client's TEST book per metal, in the metal's display unit (g gold, kg silver).



## OpenAPI

````yaml /openapi.json get /api/trading/test/v1/positions
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: >-
      Simulated orders for building and testing your integration. Nothing is
      booked. Available on request through the Bullionwale desk.
    name: Test environment
  - description: >-
      Real orders. Switched off: production trading is not available yet and,
      once it opens, is enabled per account by Bullionwale.
    name: Production environment
paths:
  /api/trading/test/v1/positions:
    get:
      tags:
        - Test environment
      summary: Test positions
      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.


        The client's TEST book per metal, in the metal's display unit (g gold,
        kg silver).
      operationId: test_positions_api_trading_test_v1_positions_get
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestPositions'
          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:
    TestPositions:
      properties:
        gold:
          $ref: '#/components/schemas/MetalPosition'
        silver:
          $ref: '#/components/schemas/MetalPosition'
      required:
        - gold
        - silver
      title: TestPositions
      type: object
    ApiError:
      description: Every refusal on the trading API.
      properties:
        detail:
          $ref: '#/components/schemas/ApiErrorDetail'
      required:
        - detail
      title: ApiError
      type: object
    MetalPosition:
      properties:
        free:
          title: Free
          type: string
        limit:
          title: Limit
          type: string
        net:
          title: Net
          type: string
        unit:
          description: '`g` for gold, `kg` for silver.'
          title: Unit
          type: string
        used:
          title: Used
          type: string
      required:
        - net
        - limit
        - used
        - free
        - unit
      title: MetalPosition
      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.