qs/getStreams

POST api/qs/getStreams

Retrieves a list of all created quote streams.

Request

Schema

{
}

Example

{
}

Request Fields

This endpoint does not require any parameters.

Response

Schema

{
  "streams": [
    {
      "streamId": <UUID>,
      "instrument": <string>,
      "takers": <array[Efx::ClientId]>
    }
  ]
}

Example

{
  "streams": [
    {
      "streamId": "1001c623-c99b-4a06-9577-fd91ae8b600f",
      "instrument": "BTC-EUR",
      "takers": [2]
    }
  ]
}

Response Fields

Field	Type	Description
streams	array	List of stream objects
streams[].streamId	UUID	Stream ID, required
streams[].instrument	string	Instrument name
streams[].takers	array[Efx::ClientId]	Takers allowed to receive the stream
streams[].apiKey	string	API key the stream is attached to, optional