qs/addStream

POST api/qs/addStream

Creates a new quote stream, which is required to start quoting. There are two options: specify the taker IDs to receive the stream, or leave it unspecified, making the stream available to all connected counterparties (CPs).

Request

Schema

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

Example

{
  "streamId": "49e6ded7-a402-4169-b766-05fd430601cf",
  "instrument": "BTC-EUR",
  "takers": [2]
}

Request Fields

Field	Type	Description
streamId	UUID	Stream ID, optional (generated by FM if not provided)
instrument	string	Instrument name, required
takers	array[Efx::ClientId]	Takers allowed to receive this stream, optional

Response

Schema

{
  "streamId": <UUID>,
  "error": <int>
}

Example

{
  "streamId": "49e6ded7-a402-4169-b766-05fd430601cf"
}

Response Fields

Field	Type	Description
streamId	UUID	ID of the created stream, required if successful
error	int	Error code, required if the request failed