> This page is for Trading.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.immix.xyz/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.immix.xyz/_mcp/server.

# List positions

GET /positions

Lists the organisation's derivative positions, one row per account and instrument a fill has opened, a flat one included. Ordered by `accountId` then `instrumentId`; a `view` other than `latest` is 400; a member without the surface is 503 `POSITIONS_UNAVAILABLE`. Needs `orders:read` or any `orders` capability, or `risk:read` or any `risk` capability.

Reference: https://docs.immix.xyz/trading/api-reference/rest-api/positions/list

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Query parameters

- `accountId` (integer, optional) — Only rows whose `accountId` is one of these; repeat the parameter or comma-separate, at most 100 values. A value the row cannot carry (not a positive 32-bit integer) refuses 400 `MALFORMED_REQUEST`; a value naming no row yields an empty collection.
- `instrumentId` (string, optional) — Only rows whose `instrumentId` is one of these; repeat the parameter or comma-separate, at most 100 values. A value the row cannot carry (not a positive 64-bit integer in decimal digits) refuses 400 `MALFORMED_REQUEST`; a value naming no row yields an empty collection.
- `sort` (string, optional, default: accountId,instrumentId) — Comma-separated `accountId`, `instrumentId` or `lastSeq`; prefix `-` for descending. Default `accountId,instrumentId`.
- `limit` (integer, optional) — Page size, 1-100; larger values are clamped. Without it the whole collection is served as one page.
- `cursor` (string, optional) — `nextCursor` or `prevCursor` from a previous page, sent with the same filters and the same `sort`. One that does not decode, or that came from another query, is refused 400 `INVALID_CURSOR`: drop it and fetch the first page.
- `include` (enum, optional) — `total` adds the exact number of rows matching the filters. This collection has no terminal state, so `include` takes `total` alone: `deleted` is a value off its grammar (400).
  - Allowed values: `total`
- `minGlobalSequence` (string, optional) — A position you hold — an `X-Immix-Global-Sequence` you read, or a 202's `commandGlobalSequence`: this member answers only once it has folded the platform's stream through it, waiting up to its deadline, then 503 `PROJECTION_BEHIND` with `Retry-After`. Within that stream a read is never older than what you have seen; drop your positions after an announced stream cut. A retry stating its 202's position attaches to or replays that operation while the journal holds its key, never publishing twice. Stated once: one to nineteen digits, at most 9223372036854775807; else 400 `MALFORMED_REQUEST`.

### Headers

- `X-Request-Id` (string, optional) — Your own id for the request: 8 to 128 of `[A-Za-z0-9._-]`. It becomes the request's id and is echoed on the response. A value off that grammar is replaced with a fresh id, never refused.

## Response

### 200

A page of the positions inside the principal's org, account then instrument ascending or in the order `sort` asks — all of them unless `limit` is sent; the position it was read at rides the body and the headers.

- `asOfSeqTsNs` (string, required, nullable) — The sequencer timestamp (epoch-ns) the data is complete through; also sent as X-Immix-As-Of-Seq-Ts. Null when unknown.
- `globalSequence` (string, required) — The position as a decimal string — the last change this member had applied, orders, balance readings and algo instances included.
- `items` (list of PositionRow, required)
- `nextCursor` (string, required, nullable) — Pass as `cursor` for the next page. Null on the last page.
- `prevCursor` (string, required, nullable) — Pass as `cursor` for the previous page. Null on the first page.
- `total` (integer, required, nullable) — Exact count matching the filter. Null unless `include=total`.

## Errors

### 400 List Positions Request Bad Request Error

The request's shape is wrong: a non-positive id, an unknown `view` or filter value, a query string that does not decode, a query parameter the operation does not take, or a cursor that does not decode or came from another query (`INVALID_CURSOR`). No position rides a refusal that consulted no state.

- `error` (ErrorBody, required) — What a refusal states. Since `0.12.0` every refusal carries all four members; a member below it sends `code`, sometimes `message`, and neither of the others.
- `currentVersion` (string, optional) — On 412 `VERSION_CONFLICT`, or `CONFIG_SEQ_CONFLICT` on an algo instance's config write: the row's current version (the `ETag` carries the same token) — re-read, reapply, retry.

### 401 List Positions Request Unauthorized Error

No bearer token, or one that does not verify.

- `error` (ErrorBody, required) — What a refusal states. Since `0.12.0` every refusal carries all four members; a member below it sends `code`, sometimes `message`, and neither of the others.
- `currentVersion` (string, optional) — On 412 `VERSION_CONFLICT`, or `CONFIG_SEQ_CONFLICT` on an algo instance's config write: the row's current version (the `ETag` carries the same token) — re-read, reapply, retry.

### 403 List Positions Request Forbidden Error

`CAPABILITY_DENIED`: a read your capabilities do not cover, or a staging route without its propose bit (`accounts:propose`). `NOT_REGISTERED`: no row or open invitation at your verified address, an unknown organisation, or an unclaimed row (an administrator admits it). `EMAIL_UNVERIFIED`: verify, then sign in again. `INVITATION_EXPIRED`: an administrator re-invites. `FORBIDDEN_PRINCIPAL`: no `org_id`, a non-ASCII ref, a disabled user, a binding with no user. `ORG_NOT_ACTIVE`: disabled, pending or deleted. Owners' 403s carry the position header and `Idempotent-Replay`.

- `error` (ErrorBody, required) — What a refusal states. Since `0.12.0` every refusal carries all four members; a member below it sends `code`, sometimes `message`, and neither of the others.
- `currentVersion` (string, optional) — On 412 `VERSION_CONFLICT`, or `CONFIG_SEQ_CONFLICT` on an algo instance's config write: the row's current version (the `ETag` carries the same token) — re-read, reapply, retry.

### 503 List Positions Request Service Unavailable Error

This member cannot serve positions now: `NOT_PRIMED` — it is still catching up; retry shortly — `PROJECTION_BEHIND` — behind your `minGlobalSequence`; retry after `Retry-After` — or `POSITIONS_UNAVAILABLE` — it is deployed without the positions surface, so no position is readable here and a retry changes nothing; every other route is unaffected.

- `error` (ErrorBody, required) — What a refusal states. Since `0.12.0` every refusal carries all four members; a member below it sends `code`, sometimes `message`, and neither of the others.
- `currentVersion` (string, optional) — On 412 `VERSION_CONFLICT`, or `CONFIG_SEQ_CONFLICT` on an algo instance's config write: the row's current version (the `ETag` carries the same token) — re-read, reapply, retry.

## Types

### PositionRow

One account's derivative position in one instrument — the platform's own derivation from the account's executions, keyed by (`accountId`, `instrumentId`), the pair, the upsert key. Every fill, bust, correction and late attribution moves it; a position back at zero keeps its row, realized PnL and fees. Spot holdings are balances, never positions. No version, so no `ETag` and no entity route. Not valued: no mark and no unrealized PnL are served.

- `accountId` (integer, required) — The account holding the position (`GET /accounts`).
- `instrumentId` (string, required) — The instrument, int64 as a decimal string — the id `GET /orders` and `POST /orders` use.
- `family` (enum, required) — How the position is held. `LINEAR` (futures, perpetual swaps): `qty` in the base coin, `cost` and `realizedPnl` in the settle asset at the price scale. `INVERSE` (coin-margined futures and swaps): `qty` in USD face value, `cost` and `realizedPnl` in the settle coin. `UNSUPPORTED`: an instrument type the platform does not value — `qty` is the raw contract count, and `settleAssetId`, `cost`, `avgPx` and `realizedPnl` are null. The value set is append-only: read an unknown value as `UNSUPPORTED`.
  - Allowed values: `LINEAR`, `INVERSE`, `UNSUPPORTED`
- `qty` (string, required) — money (an exact decimal string at the scale the row holds it, trailing zeros included): The signed position — positive long, negative short, zero flat: coins for `LINEAR`, USD face value for `INVERSE`, raw contracts for `UNSUPPORTED`. Held in units no contract definition can change, so a venue's redenomination moves `contracts`, never this.
- `contracts` (string, required, nullable) — money (an exact decimal string at the scale the row holds it, trailing zeros included): The contract count, signed, derived from `qty` at the instrument's current definition and never stored — after a contract-size change it follows the venue's count. Null for a `LINEAR` or `INVERSE` row whose instrument this member holds no definition for; for `UNSUPPORTED`, the raw contract count, equal to `qty`, with or without a definition.
- `settleAssetId` (integer, required, nullable) — The asset `cost` and `realizedPnl` are stated in: the instrument's settle asset — its quote for a linear contract, its base coin for an inverse one where the instrument states none. Null for `UNSUPPORTED`.
- `cost` (string, required, nullable) — money (an exact decimal string at the scale the row holds it, trailing zeros included): The cost basis, in `settleAssetId`, signed with the position (a short's is negative); zero when flat. Null for `UNSUPPORTED`.
- `avgPx` (string, required, nullable) — money (an exact decimal string at the scale the row holds it, trailing zeros included): The average entry price — `cost ÷ qty` for `LINEAR`, `qty ÷ cost` for `INVERSE` — rounded half-even to the price scale. Null when flat, for `UNSUPPORTED`, and for an `INVERSE` row whose instrument this member holds no definition for.
- `realizedPnl` (string, required, nullable) — money (an exact decimal string at the scale the row holds it, trailing zeros included): Realized PnL since the position was first opened, in `settleAssetId`, gross of fees — `fees` lists those apart. Cumulative: it survives the position returning to zero. Null for `UNSUPPORTED`.
- `funding` (string, required, nullable) — money (an exact decimal string at the scale the row holds it, trailing zeros included): Funding paid or received on this position since it was first opened — the payments booked to it and any approved funding adjustment — in `settleAssetId`: positive when the account received it. Cash beside `realizedPnl`, never part of it or of `cost`; it survives the position returning to zero. Null for `UNSUPPORTED`.
- `fees` (list of PositionFee, required) — Fees charged on this position's fills, cumulative, one entry per fee asset, in ascending `assetId` order; empty when none was stated. A rebate counts negative.
- `lastCause` (enum, required) — What last moved the row: a `FILL`; a venue's `BUST` or `CORRECTION` of an earlier fill, the position rewound and replayed without it or with its corrected values; the `ATTRIBUTION` of a fill discovered at the venue to its order; a `MANUAL_ADJUSTMENT` of its cost, realized PnL, fees or funding applied (since 0.58.0, `GET /risk/adjustments`; funding since 0.73.0); or a `FUNDING` payment booked on it (since 0.73.0) — the last two name no execution. The value set is append-only: read an unknown value as `UNKNOWN`.
  - Allowed values: `UNKNOWN`, `FILL`, `BUST`, `CORRECTION`, `ATTRIBUTION`, `MANUAL_ADJUSTMENT`, `FUNDING`
- `lastExecutionId` (string, required) — The execution that last moved the row (`GET /executions/{id}`), int64 as a decimal string. A hand-made adjustment or a funding payment names none: after one (`lastCause` `MANUAL_ADJUSTMENT` or `FUNDING`) this still names the last execution.
- `lastFillTsNs` (string, required, nullable) — When that execution filled at the venue — epoch nanoseconds as a decimal string; null when the venue stated no time.
- `lastSeq` (string, required) — The platform stream position of the event that last moved the row, int64 as a decimal string — the same position `globalSequence` states for the page: a row whose `lastSeq` is at or below a page's `globalSequence` is as of that page.

### ErrorBody

What a refusal states. Since `0.12.0` every refusal carries all four members; a member below it sends `code`, sometimes `message`, and neither of the others.

- `code` (string, required) — The code to branch on — stable and open (before 1.0.0 a minor may remove one, its changelog naming it): treat one you do not know by its HTTP status. The gateway's: - 400: `MALFORMED_REQUEST`, `MISSING_IDEMPOTENCY_KEY`, `INVALID_IDEMPOTENCY_KEY`, `INVALID_IF_MATCH`, `INVALID_CURSOR` - 401: `UNAUTHENTICATED` - 403: `FORBIDDEN_PRINCIPAL`, `NOT_REGISTERED`, `INVITATION_EXPIRED`, `EMAIL_UNVERIFIED`, `ORG_NOT_ACTIVE`, `CAPABILITY_DENIED` - 404: `NOT_FOUND`, `UNKNOWN_OPERATION`, `ROUTE_NOT_FOUND` (no route answers the path) - 405: `METHOD_NOT_ALLOWED` - 409: `IDEMPOTENCY_KEY_REUSED`, `INTAKE_KEY_REUSED`, `KEY_ALREADY_REGISTERED`, `CONNECTION_DOWN` (`POST /transfers`), `EXCEEDS_MARGIN_HEADROOM`, `HEADROOM_UNKNOWN` (a transfer's submit and its approval) - 413: `TOO_LARGE`, `PAYLOAD_TOO_LARGE`, `DOCUMENT_TOO_LARGE` - 422: a reference this member will not send: `INSTRUMENT_NOT_LIVE`, `ACCOUNT_NOT_ACTIVE` (`POST /orders`), `REFERENCE_UNKNOWN_INSTRUMENT`, `REFERENCE_INSTRUMENT_NOT_LIVE`, `REFERENCE_UNKNOWN_ACCOUNT` (an algo document); `VENUE_UNSUPPORTED`, `DEDICATED_KEY`, `DESTINATION_NOT_ALLOWED` - 428: `PRECONDITION_REQUIRED` - 429: `INBOX_FULL`, `IN_FLIGHT_FULL`, `RATE_LIMITED` - 500: `INTERRUPTED`, `INTERNAL_ERROR`, `PROJECTION_MISS` - 503: `NOT_PRIMED`, `NOT_SERVING`, `OWNER_ABSENT`, `INTAKE_UNAVAILABLE`, `BALANCES_UNAVAILABLE`, `POSITIONS_UNAVAILABLE`, `RISK_UNAVAILABLE`, `TRANSFERS_UNAVAILABLE`, `ALGOS_UNAVAILABLE`, `NOTIFICATIONS_UNAVAILABLE`, `TICKETS_UNAVAILABLE`, `REGISTRATION_PENDING`, `PROJECTION_BEHIND`, `LOST`, `REJECTED_NOT_REGISTERED`, `REJECTED_NOT_ACTIVE` The record owners' refusals ride verbatim — `OrgRegisterRejected.reason`, `OrderRejected.reason`, `AlgoRejected.reason`, `RiskLimitRejectReason`, `RiskAdjustmentRejectReason`, `ManualExecutionRejectReason`, `TransferRejectReason` and `NotificationEndpointRejected.reason` list them; the guide maps each to its status.
- `message` (string, required) — For display only; its wording may change at any time.
- `requestId` (string, required) — The request's id, also sent as X-Request-Id; quote it to support.
- `retryable` (boolean, required) — Whether sending the identical request again, its `Idempotency-Key` included, after `Retry-After` or a short pause, can succeed with nothing else changed. `false` where something must change first: the request, its key, its precondition, the caller's standing, or the platform's own records or deployment. A refusal the record owner judged is always `false`: it is the recorded answer to its key, which replays it.

### PositionFee

One fee asset's cumulative fees on a position.

- `assetId` (integer, required) — The asset the fees were charged in.
- `amount` (string, required) — money (an exact decimal string at the scale the row holds it, trailing zeros included): The fees charged in that asset, at the scale the fills stated them; a rebate counts negative.

## Examples

**Response**

```json
{
  "asOfSeqTsNs": "1791553927418203000",
  "globalSequence": "250113",
  "items": [
    {
      "accountId": 118310760,
      "instrumentId": "3210201020000",
      "family": "LINEAR",
      "qty": "0.03000000",
      "contracts": "3.00000000",
      "settleAssetId": 101,
      "cost": "1865.40",
      "avgPx": "62180.00",
      "realizedPnl": "6.00",
      "funding": "0.00",
      "fees": [
        {
          "assetId": 101,
          "amount": "1.428850"
        }
      ],
      "lastCause": "MANUAL_ADJUSTMENT",
      "lastExecutionId": "7263950677795",
      "lastFillTsNs": "1791543767905000000",
      "lastSeq": "250103"
    },
    {
      "accountId": 118310760,
      "instrumentId": "3210301020000",
      "family": "LINEAR",
      "qty": "-1.00000000",
      "contracts": "-10.00000000",
      "settleAssetId": 101,
      "cost": "-2453.12",
      "avgPx": "2453.12",
      "realizedPnl": "0.00",
      "funding": "0.00",
      "fees": [
        {
          "assetId": 101,
          "amount": "1.226560"
        }
      ],
      "lastCause": "FILL",
      "lastExecutionId": "7263794899902",
      "lastFillTsNs": "1791541215640000000",
      "lastSeq": "250082"
    }
  ],
  "total": 2
}
```

**SDK Code**

```python
import requests

url = "https://api.example.com/positions"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.example.com/positions';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/positions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.example.com/positions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.example.com/positions")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.example.com/positions', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.example.com/positions");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.example.com/positions")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```