List AMMs

GET 
/api/v2/amms

Get a list of AMM or filter by market ID, party ID or AMM ID

Request

Query Parameters

id string

AMM ID to filter for. If party ID or market ID is provided, the ID filter is ignored.

partyId string

Party ID to filter for.

marketId string

Market ID to filter for. If party ID is provided, the market filter is ignored.

ammPartyId string

Party's underlying AMM sub-account to filter for. A party's AMM sub-account will remain the same regardless of the AMM.

status string
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.
• 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.
pagination.first int32

Number of records to be returned that sort greater than row identified by cursor supplied in 'after'.

pagination.after string

If paging forwards, the cursor string for the last row of the previous page.

pagination.last int32

Number of records to be returned that sort less than row identified by cursor supplied in 'before'.

pagination.before string

If paging forwards, the cursor string for the first row of the previous page.

pagination.newestFirst boolean

Whether to order the results with the newest records first. If not set, the default value is true.

Responses

200

A successful response.

application/json

Schema

Schema

amms object

Page of AMM data and corresponding page information.

edges object[]

Page of AMM data and the corresponding cursors.

Array [

cursor string

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 string

Base price bound configuration for the AMM.

leverageAtLowerBound string

Leverage at lower bounds.

leverageAtUpperBound string

Leverage at upper bounds.

lowerBound string

Upper price bound configuration for the AMM. If unset, the AMM will never hold a short position.

upperBound string

Lower price bound configuration for the AMM. If unset, the AMM will never hold a long position.

ammPartyId string

Party ID that the AMM operates as.

commitment string

Amount committed to the AMM.

id string

ID of the AMM.

lowerCurve object

theoreticalPosition string

Maximum tradable volume on the AMM curve.

virtualLiquidity string

Virtual liquidity for the given AMM curve.

marketId string

Market ID that the AMM provides liquidity for.

partyId string

Party ID of the owner of the AMM.

proposedFee string

Nominated liquidity fee factor, which is an input to the calculation of taker fees on the market.

status v1AMMStatus

Possible values: [STATUS_UNSPECIFIED, STATUS_ACTIVE, STATUS_REJECTED, STATUS_CANCELLED, STATUS_STOPPED, STATUS_REDUCE_ONLY]

Default value: STATUS_UNSPECIFIED

Current status of the AMM.

statusReason AMMStatusReason

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

theoreticalPosition string

Maximum tradable volume on the AMM curve.

virtualLiquidity string

Virtual liquidity for the given AMM curve.

]

pageInfo object

Page information that is used for fetching further pages.

endCursor string

End cursor.

hasNextPage boolean

Indicator if there is a next page.

hasPreviousPage boolean

Indicator if there is a previous page.

startCursor string

Start cursor.

Example (from schema)

{
  "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"
    }
  }
}

500

An internal server error

application/json

Schema

Schema

code int32
details object[]
Array [
@type string
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:
• 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.)
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.
]
message string

Example (from schema)

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
details object[]
Array [
@type string
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:
• 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.)
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.
]
message string

Example (from schema)

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

Loading...