List AMMs
GET/api/v2/amms
Get a list of AMM or filter by market ID, party ID or AMM ID
Request
Query Parameters
- STATUS_ACTIVE: AMM is active on the market and is posting tradable volume.
- STATUS_REJECTED: AMM submission was rejected.
- STATUS_CANCELLED: AMM has been cancelled by the owner and is no longer trading.
- STATUS_STOPPED: AMM has been stopped by the network and is no longer trading.
- STATUS_REDUCE_ONLY: AMM will only trade such that it will reduce its position.
AMM ID to filter for. If party ID or market ID is provided, the ID filter is ignored.
Party ID to filter for.
Market ID to filter for. If party ID is provided, the market filter is ignored.
Party's underlying AMM sub-account to filter for. A party's AMM sub-account will remain the same regardless of the AMM.
Possible values: [STATUS_UNSPECIFIED
, STATUS_ACTIVE
, STATUS_REJECTED
, STATUS_CANCELLED
, STATUS_STOPPED
, STATUS_REDUCE_ONLY
]
Default value: STATUS_UNSPECIFIED
Filter for AMMs with the given status. This filter will be ignored if any of the other filters have been set.
Number of records to be returned that sort greater than row identified by cursor supplied in 'after'.
If paging forwards, the cursor string for the last row of the previous page.
Number of records to be returned that sort less than row identified by cursor supplied in 'before'.
If paging forwards, the cursor string for the first row of the previous page.
Whether to order the results with the newest records first. If not set, the default value is true.
Responses
- 200
- 500
- default
A successful response.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
amms object
Page of AMM data and corresponding page information.
edges object[]
Page of AMM data and the corresponding cursors.
Cursor that can be used to fetch further pages.
node object
AMM pool data.
parameters object
Liquidity parameters that define the size and range of the AMM's tradeable volume.
Base price bound configuration for the AMM.
Leverage at lower bounds.
Leverage at upper bounds.
Upper price bound configuration for the AMM. If unset, the AMM will never hold a short position.
Lower price bound configuration for the AMM. If unset, the AMM will never hold a long position.
Party ID that the AMM operates as.
Amount committed to the AMM.
ID of the AMM.
lowerCurve object
Maximum tradable volume on the AMM curve.
Virtual liquidity for the given AMM curve.
Market ID that the AMM provides liquidity for.
Party ID of the owner of the AMM.
Nominated liquidity fee factor, which is an input to the calculation of taker fees on the market.
Possible values: [STATUS_UNSPECIFIED
, STATUS_ACTIVE
, STATUS_REJECTED
, STATUS_CANCELLED
, STATUS_STOPPED
, STATUS_REDUCE_ONLY
]
Default value: STATUS_UNSPECIFIED
Current status of the AMM.
Possible values: [STATUS_REASON_UNSPECIFIED
, STATUS_REASON_CANCELLED_BY_PARTY
, STATUS_REASON_CANNOT_FILL_COMMITMENT
, STATUS_REASON_PARTY_ALREADY_OWNS_AMM_FOR_MARKET
, STATUS_REASON_PARTY_CLOSED_OUT
, STATUS_REASON_MARKET_CLOSED
, STATUS_REASON_COMMITMENT_TOO_LOW
, STATUS_REASON_CANNOT_REBASE
]
Default value: STATUS_REASON_UNSPECIFIED
Reason for the AMM's current status.
upperCurve object
Maximum tradable volume on the AMM curve.
Virtual liquidity for the given AMM curve.
pageInfo object
Page information that is used for fetching further pages.
End cursor.
Indicator if there is a next page.
Indicator if there is a previous page.
Start cursor.
{
"amms": {
"edges": [
{
"cursor": "string",
"node": {
"parameters": {
"base": "string",
"leverageAtLowerBound": "string",
"leverageAtUpperBound": "string",
"lowerBound": "string",
"upperBound": "string"
},
"ammPartyId": "string",
"commitment": "string",
"id": "string",
"lowerCurve": {
"theoreticalPosition": "string",
"virtualLiquidity": "string"
},
"marketId": "string",
"partyId": "string",
"proposedFee": "string",
"status": "STATUS_UNSPECIFIED",
"statusReason": "STATUS_REASON_UNSPECIFIED",
"upperCurve": {
"theoreticalPosition": "string",
"virtualLiquidity": "string"
}
}
}
],
"pageInfo": {
"endCursor": "string",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "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"
}