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

# List venues

GET /venues

The venues this environment serves, sorted by code unless `sort` says otherwise. Page with `limit` and `cursor`.

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

## Authentication

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

## Request

### Query parameters

- `search` (string, optional) — Case-insensitive substring of the code or display name.
- `code` (string, optional) — Only these venue codes; repeat the parameter or comma-separate.
- `sort` (string, optional) — Comma-separated `code`, `displayName` or `venueId`; prefix `-` for descending. Default `code`.
- `limit` (integer, optional) — Page size, 1-100; larger values are clamped. Default 50.
- `cursor` (string, optional) — `nextCursor` or `prevCursor` from a previous page, sent with the same filters and sort.
- `include` (string, optional) — `total` adds the exact number of matching venues.

## Response

### 200

A page of venues.

- `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.
- `items` (list of Venue, 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 Venues Request Bad Request Error

The request is malformed, or its cursor is not valid for it.

- `error` (ErrorBody, required)

### 401 List Venues Request Unauthorized Error

The bearer token is missing or not valid.

- `error` (ErrorBody, required)

### 503 List Venues Request Service Unavailable Error

A store is temporarily unavailable; retry.

- `error` (ErrorBody, required)

## Types

### Venue

A trading venue that IMMIX connects to.

- `code` (string, required) — The venue code. Instrument symbols carry it upper-cased as their venue prefix: `okx` is the `OKX@` in `OKX@BTC/USDT`.
- `displayName` (string, required) — The name to show people.
- `updatedAtNs` (string, required, nullable) — When the venue record last changed, as a sequencer timestamp in epoch nanoseconds. Null when unknown.
- `venueId` (string, required) — The venue's id. Ids are opaque strings.

### ErrorBody

- `code` (string, required) — Machine-readable, UPPER_SNAKE and append-only; tolerate codes you don't know. Branch on this, never on the message.
- `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 the same request may succeed if retried later.

## Examples

**Response**

```json
{
  "asOfSeqTsNs": "asOfSeqTsNs",
  "items": [
    {
      "code": "okx",
      "displayName": "OKX",
      "updatedAtNs": "1758640000000000000",
      "venueId": "1"
    }
  ],
  "nextCursor": "nextCursor",
  "prevCursor": "prevCursor",
  "total": 1
}
```

**SDK Code**

```python
import requests

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

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

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

print(response.json())
```

```javascript
const url = 'https://api.example.com/venues';
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/venues"

	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/venues")

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/venues")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

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

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

```csharp
using RestSharp;

var client = new RestClient("https://api.example.com/venues");
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/venues")! 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()
```