Estimate AMM bounds

GET 
/api/v2/estimate/amm/bounds

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

Request

Query Parameters

basePrice string

Base price of the AMM pool, the price is an integer, for example 123456 is a correctly formatted price of 1.23456 assuming market configured to 5 decimal places.

upperPrice string

Upper price of the AMM pool, the price is an integer, for example 123456 is a correctly formatted price of 1.23456 assuming market configured to 5 decimal places.

lowerPrice string

Lower price of the AMM pool, the price is an integer, for example 123456 is a correctly formatted price of 1.23456 assuming market configured to 5 decimal places.

leverageAtUpperPrice string

Leverage at the upper price of the AMM pool.

leverageAtLowerPrice string

Leverage at the lower price of the AMM pool.

commitmentAmount string

Amount of the asset that the party is willing to commit to the AMM pool.

marketId string

Market ID to estimate the AMM for.

Responses

200

A successful response.

application/json

Schema

Schema

ammError EstimateAMMBoundsResponseAMMError (string)

Possible values: [AMM_ERROR_UNSPECIFIED, AMM_ERROR_COMMITMENT_BELOW_MINIMUM, AMM_ERROR_LOWER_BOUND_TOO_WIDE, AMM_ERROR_UPPER_BOUND_TOO_WIDE, AMM_ERROR_BOTH_BOUNDS_TOO_WIDE]

Default value: AMM_ERROR_UNSPECIFIED

If populated the bounds could be calculated but the AMM is invalid for other reasons.

liquidationPriceAtLower string

Estimated price below the lower bound at which the commitment will be lost.

liquidationPriceAtUpper string

Estimated price above upper bound at which the commitment will be lost.

lossOnCommitmentAtLower string

Loss of commitment at the lower bound.

lossOnCommitmentAtUpper string

Loss of commitment at the upper bound.

positionSizeAtLower string

Theoretical volume at the top of the lower bound.

positionSizeAtUpper string

Theoretical volume at the top of the upper bound.

Example (from schema)

{
  "ammError": "AMM_ERROR_UNSPECIFIED",
  "liquidationPriceAtLower": "string",
  "liquidationPriceAtUpper": "string",
  "lossOnCommitmentAtLower": "string",
  "lossOnCommitmentAtUpper": "string",
  "positionSizeAtLower": "string",
  "positionSizeAtUpper": "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...