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

# Bullionwale API

> Place and read bullion orders from your own systems with an API key.

<Warning>
  **Availability, as of 2026-10-19: test environment available on request; production trading switched off.**

  | Environment | Status |
  | - | - |
  | Test (`/api/trading/test/v1`) | **Available on request.** Ask the Bullionwale desk to turn on API access for your account and issue a test key. Test orders are simulated and nothing is booked. |
  | Production (`/api/trading/v1`) | **Switched off.** Implemented, but production orders are refused (`403 production_trading_disabled`). Bullionwale will enable it per account once it opens; it is not available today. |

  `https://api.bullionwale.com` serves the API. Without a valid key, every call answers `401`. Your Bullionwale relationship manager will tell you when production trading opens.
</Warning>

The Bullionwale API lets your own software do what you do in the Bullionwale web or mobile app: check your account, place market orders for gold and silver, follow their status, and read your positions. Your program authenticates with an API key instead of a login.

## What you can do

| Call | What it does |
| - | - |
| `GET /me` | Shows the account and key you are using, the key's scopes, and whether production trading is available to your account. |
| `POST /orders` | Places a market order. Requires an `Idempotency-Key` header so a retry never books twice. |
| `GET /orders` | Lists your orders, newest first, with filters. |
| `GET /orders/{order_id}` | Reads one order, for example to follow a pending order to its final status. |
| `GET /positions` | Shows your net position per metal against your weight allocation. |

Every call exists in two environments, with the same paths under different base paths:

* **Test**, `/api/trading/test/v1`: simulated orders. Nothing is booked, so you can build and test freely.
* **Production**, `/api/trading/v1`: real orders, booked exactly like an order you place in the app.

See [Test and production](/environments) for the differences.

## Base URL

Once the API is available, the base URL is:

```text theme={null}
https://api.bullionwale.com
```

So the test `GET /me` will be `https://api.bullionwale.com/api/trading/test/v1/me`. Check the availability notice above before you call it.

## Things to know before you start

* **You do not create keys yourself.** Bullionwale turns on API access for your account and issues your keys. See [Getting access](/getting-access).
* **Quantities are weights, not lots.** A quantity is in the symbol's measure: grams for gram-quoted symbols, kilograms for kilogram-quoted ones. Each order response says which in `unit`.
* **Amounts are strings.** Prices, totals, quantities and positions come back as decimal strings such as `"141250.00"`. Parse them as decimals, not floats.
* **Limits are weight, not money.** Your account has a weight allocation per metal. There is no rupee margin check on a market order. See [Orders, status and positions](/orders-and-positions#positions-and-your-weight-allocation).
* **Retries are safe only with the same `Idempotency-Key`.** See [Idempotency and safe retries](/idempotency).

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/quickstart">
    From a test key to your first simulated order.
  </Card>

  <Card title="Getting access" icon="key" href="/getting-access">
    How API access is turned on and how keys are issued.
  </Card>

  <Card title="Errors and troubleshooting" icon="triangle-exclamation" href="/errors">
    Every error code, rate limits, and what to do.
  </Card>

  <Card title="API reference" icon="book" href="/api-reference/overview">
    Every endpoint, generated from the OpenAPI spec.
  </Card>
</CardGroup>


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