BUbullish
amm-instructions

Get AMM Instruction by ID

Gets a specific AMM instruction based on the instructionId, requires bearer token in authorization header

Ratelimited: True

get/v2/amm-instructions/{instructionId}

Request

Response

OK

liquidityIdstring required
instructionIdstring required
symbolstring required

market symbol. E.g. BTCUSDC

baseFeestring required

see asset value format

quoteFeestring required

see asset value format

statusstring required

order status can have the following string values "OPEN", "CLOSED", "CANCELLED", "REJECTED"

statusReasonstring required

status reason, describes why the order is in a specific state

statusReasonCodeinteger required

status reason code, see details

createdAtDatetimestring date-time

ISO 8601 with millisecond as string

createdAtTimestampstring string required

unsigned 64 bit integer value which is the number of milliseconds since EPOCH expressed as string

24HrApystring

APY of the last 24 Hours, only for AMM instructions with OPEN status

24HrYieldEarnstring

amount of money earned in USD from the last 24 Hours, only for AMM instructions with OPEN status

apystring required

yield generated from the time AMM instruction was created, in annualised percentage

baseCurrentQuantitystring required

amount of base asset this AMM instruction currently holds, only for AMM instruction with OPEN status

baseInvestQuantitystring required

initial base investment

basePricestring required

current price of base asset

baseWithdrawQuantitystring required

amount of base asset returned when AMM instruction is terminated

currentValuestring required

value of assets (base and quote) in USD amount that this AMM instruction currently holds

dislocationEnabledboolean required

dislocation enabled/disabled

feeTierIdstring required

unique fee tier ID, see Get Market By Symbol

finalValuestring

value of assets (base and quote) in USD amount when AMM instruction was terminated, only for AMM instruction with CLOSED status

impermanentLossstring required

impermanent loss

initialBasePricestring required

price of base asset when AMM instruction was created

initialQuotePricestring required

price of quote asset when AMM instruction was created

initialValuestring required

value of assets (base and quote) in USD amount when AMM instruction was created

lowerBoundstring required

lower bound of price range, in quote currency

pricestring required

current price of AMM, see Get Tick By Symbol

quoteCurrentQuantitystring

amount of quote asset this AMM instruction currently holds, only for AMM instruction with OPEN status

quoteInvestQuantitystring required

initial quote investment

quotePricestring required

current price of quote asset

quoteWithdrawQuantitystring required

amount of quote asset returned when AMM instruction is terminated

lastDistributedPricestring nullable

(Perpetual market only) The price used at the time of settlement for AMM Instructions that can be used to determine mtmPnl and the actual Pnl

requestIdstring required
staticSpreadFeestring required

static spread fee, see Get Market By Symbol

updatedAtDatetimestring date-time

ISO 8601 with millisecond as string

updatedAtTimestampstring string required

unsigned 64 bit integer value which is the number of milliseconds since EPOCH expressed as string

upperBoundstring required

upper bound of price range, in quote currency

yieldEarnstring required

amount of money earned in USD

Example response

{
  "liquidityId": "297735387747975680",
  "instructionId": "297735387747975680",
  "symbol": "BTCUSDC",
  "baseFee": "1.00000000",
  "quoteFee": "1.00000000",
  "status": "OPEN",
  "statusReason": "Ok",
  "statusReasonCode": 1001,
  "createdAtDatetime": "2025-05-20T01:01:01.000Z",
  "createdAtTimestamp": "1621490985000",
  "24HrApy": "2.3319",
  "24HrYieldEarn": "0.00",
  "apy": "0.0000",
  "baseCurrentQuantity": "0.00000000",
  "baseInvestQuantity": "0.00000008",
  "basePrice": "345.6700",
  "baseWithdrawQuantity": "0.00000010",
  "currentValue": "0.0000",
  "feeTierId": "1",
  "finalValue": "0.0001",
  "impermanentLoss": "0.0000",
  "initialBasePrice": "100.0000",
  "initialQuotePrice": "0.0100",
  "initialValue": "0.0000",
  "lowerBound": "0.0013",
  "price": "456.7800",
  "quoteCurrentQuantity": "0.0000",
  "quoteInvestQuantity": "0.0009",
  "quotePrice": "1.0000",
  "quoteWithdrawQuantity": "0.0011",
  "requestId": "197735387747975680",
  "staticSpreadFee": "0.00200000",
  "updatedAtDatetime": "2025-05-20T01:01:01.000Z",
  "updatedAtTimestamp": "1621490985000",
  "upperBound": "14000.0000",
  "yieldEarn": "0.00"
}

Changes

No recorded changes to this operation across all 1 revision of this API.