List liquidity provisions

GET 
/api/v2/liquidity/all-provisions

Get a list of liquidity provisions for a given market. This API returns a current and pending liquidity provision in the event that a provision has been updated by the provider but the updated provision will not be active until the next epoch.

Request

Query Parameters

marketId string

Restrict liquidity provisions to those placed on the given market.

partyId string

Restrict liquidity provisions to those placed by the given party.

reference string

Restrict liquidity provisions to those with the given order reference.

live boolean

Whether to include live liquidity provisions. If not set, live orders will not be included.

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

liquidityProvisions object

Page of liquidity provisions data and corresponding page information.

edges object[]

Page of liquidity provisions data and their corresponding cursors.

Array [

cursor string

Cursor that can be used to fetch further pages.

node object

Data corresponding to a liquidity provider's commitment.

current object

Liquidity provision that is currently live.

buys object[]

Set of liquidity buy orders to meet the liquidity provision obligation.

Array [

liquidityOrder object

Liquidity order from the original submission.

offset string

Offset/amount of units away for the order. This field is an unsigned integer scaled using the market's decimal places.

proportion int64

Relative proportion of the commitment to be allocated at a price level.

reference Pegged reference defines which price point a pegged order is linked to - meaning the price for a pegged order is calculated from the value of the reference price point

Possible values: [PEGGED_REFERENCE_UNSPECIFIED, PEGGED_REFERENCE_MID, PEGGED_REFERENCE_BEST_BID, PEGGED_REFERENCE_BEST_ASK]

Default value: PEGGED_REFERENCE_UNSPECIFIED

Pegged reference point for the order.

orderId string

Unique ID of the pegged order generated to fulfil this liquidity order.

]

commitmentAmount string

Specified as a unitless number that represents the amount of settlement asset of the market. This field is an unsigned integer scaled to the asset's decimal places.

createdAt int64

Timestamp in Unix nanoseconds for when the liquidity provision was created.

fee string

Nominated liquidity fee factor, which is an input to the calculation of taker fees on the market, as per setting fees and rewarding liquidity providers.

id string

Unique ID for the liquidity provision.

marketId string

Market ID for the liquidity provision.

partyId string

Unique party ID for the creator of the provision.

reference string

Reference shared between this liquidity provision and all its orders.

sells object[]

Set of liquidity sell orders to meet the liquidity provision obligation.

Array [

liquidityOrder object

Liquidity order from the original submission.

offset string

Offset/amount of units away for the order. This field is an unsigned integer scaled using the market's decimal places.

proportion int64

Relative proportion of the commitment to be allocated at a price level.

reference Pegged reference defines which price point a pegged order is linked to - meaning the price for a pegged order is calculated from the value of the reference price point

Possible values: [PEGGED_REFERENCE_UNSPECIFIED, PEGGED_REFERENCE_MID, PEGGED_REFERENCE_BEST_BID, PEGGED_REFERENCE_BEST_ASK]

Default value: PEGGED_REFERENCE_UNSPECIFIED

Pegged reference point for the order.

orderId string

Unique ID of the pegged order generated to fulfil this liquidity order.

]

status vegaLiquidityProvisionStatus

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

Default value: STATUS_UNSPECIFIED

Status of this liquidity provision.

updatedAt int64

Timestamp in Unix nanoseconds for when the liquidity provision was updated.

version uint64

Version of this liquidity provision.

pending object

Liquidity provision that is currently pending and will go live in the next epoch.

buys object[]

Set of liquidity buy orders to meet the liquidity provision obligation.

Array [

liquidityOrder object

Liquidity order from the original submission.

offset string

Offset/amount of units away for the order. This field is an unsigned integer scaled using the market's decimal places.

proportion int64

Relative proportion of the commitment to be allocated at a price level.

reference Pegged reference defines which price point a pegged order is linked to - meaning the price for a pegged order is calculated from the value of the reference price point

Possible values: [PEGGED_REFERENCE_UNSPECIFIED, PEGGED_REFERENCE_MID, PEGGED_REFERENCE_BEST_BID, PEGGED_REFERENCE_BEST_ASK]

Default value: PEGGED_REFERENCE_UNSPECIFIED

Pegged reference point for the order.

orderId string

Unique ID of the pegged order generated to fulfil this liquidity order.

]

commitmentAmount string

Specified as a unitless number that represents the amount of settlement asset of the market. This field is an unsigned integer scaled to the asset's decimal places.

createdAt int64

Timestamp in Unix nanoseconds for when the liquidity provision was created.

fee string

Nominated liquidity fee factor, which is an input to the calculation of taker fees on the market, as per setting fees and rewarding liquidity providers.

id string

Unique ID for the liquidity provision.

marketId string

Market ID for the liquidity provision.

partyId string

Unique party ID for the creator of the provision.

reference string

Reference shared between this liquidity provision and all its orders.

sells object[]

Set of liquidity sell orders to meet the liquidity provision obligation.

Array [

liquidityOrder object

Liquidity order from the original submission.

offset string

Offset/amount of units away for the order. This field is an unsigned integer scaled using the market's decimal places.

proportion int64

Relative proportion of the commitment to be allocated at a price level.

reference Pegged reference defines which price point a pegged order is linked to - meaning the price for a pegged order is calculated from the value of the reference price point

Possible values: [PEGGED_REFERENCE_UNSPECIFIED, PEGGED_REFERENCE_MID, PEGGED_REFERENCE_BEST_BID, PEGGED_REFERENCE_BEST_ASK]

Default value: PEGGED_REFERENCE_UNSPECIFIED

Pegged reference point for the order.

orderId string

Unique ID of the pegged order generated to fulfil this liquidity order.

]

status vegaLiquidityProvisionStatus

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

Default value: STATUS_UNSPECIFIED

Status of this liquidity provision.

updatedAt int64

Timestamp in Unix nanoseconds for when the liquidity provision was updated.

version uint64

Version of this liquidity provision.

]

pageInfo object

Page information that is used to fetch 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)

{
  "liquidityProvisions": {
    "edges": [
      {
        "cursor": "string",
        "node": {
          "current": {
            "buys": [
              {
                "liquidityOrder": {
                  "offset": "string",
                  "proportion": 0,
                  "reference": "PEGGED_REFERENCE_UNSPECIFIED"
                },
                "orderId": "string"
              }
            ],
            "commitmentAmount": "string",
            "createdAt": "string",
            "fee": "string",
            "id": "string",
            "marketId": "string",
            "partyId": "string",
            "reference": "string",
            "sells": [
              {
                "liquidityOrder": {
                  "offset": "string",
                  "proportion": 0,
                  "reference": "PEGGED_REFERENCE_UNSPECIFIED"
                },
                "orderId": "string"
              }
            ],
            "status": "STATUS_UNSPECIFIED",
            "updatedAt": "string",
            "version": "string"
          },
          "pending": {
            "buys": [
              {
                "liquidityOrder": {
                  "offset": "string",
                  "proportion": 0,
                  "reference": "PEGGED_REFERENCE_UNSPECIFIED"
                },
                "orderId": "string"
              }
            ],
            "commitmentAmount": "string",
            "createdAt": "string",
            "fee": "string",
            "id": "string",
            "marketId": "string",
            "partyId": "string",
            "reference": "string",
            "sells": [
              {
                "liquidityOrder": {
                  "offset": "string",
                  "proportion": 0,
                  "reference": "PEGGED_REFERENCE_UNSPECIFIED"
                },
                "orderId": "string"
              }
            ],
            "status": "STATUS_UNSPECIFIED",
            "updatedAt": "string",
            "version": "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...