Observe liquidity provisions
GET/api/v2/stream/liquidity-provisions
Subscribe to a stream of liquidity provision events for a given market and party
Request
Query Parameters
Target market to observe for liquidity provisions.
Target party to observe for submitted liquidity provisions.
Responses
- 200
- 500
- default
A successful response.(streaming responses)
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- If no scheme is provided,
https
is assumed. - An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
- Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
- ]
- Array [
- Array [
- ]
- Array [
- ]
- ]
error object
details object[]
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
result object
liquidityProvisions object[]
buys object[]
Set of liquidity buy orders to meet the liquidity provision obligation.
liquidityOrder object
Liquidity order from the original submission.
Offset/amount of units away for the order. This field is an unsigned integer scaled using the market's decimal places.
Relative proportion of the commitment to be allocated at a price level.
Possible values: [PEGGED_REFERENCE_UNSPECIFIED
, PEGGED_REFERENCE_MID
, PEGGED_REFERENCE_BEST_BID
, PEGGED_REFERENCE_BEST_ASK
]
Default value: PEGGED_REFERENCE_UNSPECIFIED
Pegged reference point for the order.
Unique ID of the pegged order generated to fulfil this liquidity order.
Specified as a unitless number that represents the amount of settlement asset of the market. This field is an unsigned integer scaled to the asset's decimal places.
Timestamp in Unix nanoseconds for when the liquidity provision was created.
Nominated liquidity fee factor, which is an input to the calculation of taker fees on the market, as per setting fees and rewarding liquidity providers.
Unique ID for the liquidity provision.
Market ID for the liquidity provision.
Unique party ID for the creator of the provision.
Reference shared between this liquidity provision and all its orders.
sells object[]
Set of liquidity sell orders to meet the liquidity provision obligation.
liquidityOrder object
Liquidity order from the original submission.
Offset/amount of units away for the order. This field is an unsigned integer scaled using the market's decimal places.
Relative proportion of the commitment to be allocated at a price level.
Possible values: [PEGGED_REFERENCE_UNSPECIFIED
, PEGGED_REFERENCE_MID
, PEGGED_REFERENCE_BEST_BID
, PEGGED_REFERENCE_BEST_ASK
]
Default value: PEGGED_REFERENCE_UNSPECIFIED
Pegged reference point for the order.
Unique ID of the pegged order generated to fulfil this liquidity order.
Possible values: [STATUS_UNSPECIFIED
, STATUS_ACTIVE
, STATUS_STOPPED
, STATUS_CANCELLED
, STATUS_REJECTED
, STATUS_UNDEPLOYED
, STATUS_PENDING
]
Default value: STATUS_UNSPECIFIED
Status of this liquidity provision.
Timestamp in Unix nanoseconds for when the liquidity provision was updated.
Version of this liquidity provision.
{
"error": {
"code": 0,
"details": [
{
"@type": "string"
}
],
"message": "string"
},
"result": {
"liquidityProvisions": [
{
"buys": [
{
"liquidityOrder": {
"offset": "string",
"proportion": 0,
"reference": "PEGGED_REFERENCE_UNSPECIFIED"
},
"orderId": "string"
}
],
"commitmentAmount": "string",
"createdAt": "string",
"fee": "string",
"id": "string",
"marketId": "string",
"partyId": "string",
"reference": "string",
"sells": [
{
"liquidityOrder": {
"offset": "string",
"proportion": 0,
"reference": "PEGGED_REFERENCE_UNSPECIFIED"
},
"orderId": "string"
}
],
"status": "STATUS_UNSPECIFIED",
"updatedAt": "string",
"version": "string"
}
]
}
}
An internal server error
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- If no scheme is provided,
https
is assumed. - An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
- Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
- ]
details object[]
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
{
"code": 0,
"details": [
{
"@type": "string"
}
],
"message": "string"
}
An unexpected error response.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- If no scheme is provided,
https
is assumed. - An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
- Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
- ]
details object[]
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
{
"code": 0,
"details": [
{
"@type": "string"
}
],
"message": "string"
}