Skip to main content
POST
/
api
/
v1
/
hosts
/
query
/
List
List all available execution hosts (brokers)
curl --request POST \
  --url https://api.plurex.io/api/v1/hosts/query/List \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-API-SECRET: <api-key>' \
  --data '
{
  "cursor": "<string>"
}
'
{
  "traceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "serverTime": "2023-11-07T05:31:56Z",
  "items": [
    {
      "id": "<string>",
      "isRestricted": true,
      "targetVenueId": "<string>",
      "features": {
        "leverageScopes": "<string>",
        "positionModeScopes": "<string>"
      },
      "isPaper": true,
      "supportedCredentialTypes": [
        "ApiKey"
      ]
    }
  ],
  "warnings": [
    "<string>"
  ],
  "nextCursor": "<string>"
}

Authorizations

X-API-KEY
string
header
required
X-API-SECRET
string
header
required

Body

application/json
cursor
string | null

Response

200 - application/json

Successful response

traceId
string<uuid>
required

Unique identifier for tracing.

serverTime
string<date-time>
required

RFC3339 timestamp of processing.

items
object[]
required
warnings
string[]
nextCursor
string | null

Use this value in the next request to fetch the following page.