Skip to main content
Version: pre-release (v0.79)

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, STATUS_PENDING]

    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.
    • STATUS_PENDING: AMM is waiting for a base price from its configured data source.
    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.

    liveOnly boolean

    Restrict AMMs to those that are actively trading. If not set, it is treated as being false.

Responses​

A successful response.

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.

    dataSourceId string

    Data source that is used to re-price the AMM's base.

    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.

    minimumPriceChangeTrigger string

    An AMM with an oracle driven base price will only be updated if abs(new-base-price / old-base-price - 1) >= minimum_price_change_trigger.

    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 (string)

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

    Default value: STATUS_UNSPECIFIED

    Current status of the AMM.

    statusReason AMMStatusReason (string)

    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.

Loading...