List liquidity provisions

Get a list of liquidity provisions for a given market using a cursor based pagination

Query Parameters

marketId string

Target market for the liquidity provision orders.

partyId string

Party which submitted the liquidity provision orders.

reference string

Reference of the liquidity provision.

live boolean

Indicator if the listed liquidity provision orders will include live orders or not.

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

Newest records first, older records last, default is true.

Responses

• 200
• 500
• default

---

A successful response.

application/json

Schema

Example (from schema)

---

Schema

liquidityProvisions object
Page of liquidity provisions data and corresponding page information.
edges object[]
Page of liquidity provisions data and their corresponding cursors.
cursor string
node object
Data corresponding to a liquidity provider's commitment.
buys object[]
Set of liquidity buy orders to meet the liquidity provision obligation.
liquidityOrder object
Liquidity order from the original submission.
offset string
proportion int64
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]
orderId string
commitmentAmount string
createdAt int64
fee string
id string
marketId string
partyId string
reference string
sells object[]
Set of liquidity sell orders to meet the liquidity provision obligation.
liquidityOrder object
Liquidity order from the original submission.
offset string
proportion int64
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]
orderId string
status string
Possible values: [STATUS_UNSPECIFIED, STATUS_ACTIVE, STATUS_STOPPED, STATUS_CANCELLED, STATUS_REJECTED, STATUS_UNDEPLOYED, STATUS_PENDING]
updatedAt int64
version uint64
pageInfo object
Page information that is used for fetching further pages.
endCursor string
hasNextPage boolean
hasPreviousPage boolean
startCursor string

{
  "liquidityProvisions": {
    "edges": [
      {
        "cursor": "string",
        "node": {
          "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"
    }
  }
}

An internal server error

application/json

Schema

Example (from schema)

---

Schema

code int32
details object[]
@type string
message string

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

An unexpected error response.

application/json

Schema

Example (from schema)

---

Schema

code int32
details object[]
@type string
message string

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

GET /api/v2/liquidity/provisions

Request

Base URL

https://vega-mainnet-data.commodum.io

marketId — query

partyId — query

reference — query

live — query

---truefalse

pagination.first — query

pagination.after — query

pagination.last — query

pagination.before — query

pagination.newestFirst — query

---truefalse

curl / cURL

curl -L -X GET 'https://vega-mainnet-data.commodum.io/api/v2/liquidity/provisions' \
-H 'Accept: application/json'

python / requests

curl -L -X GET 'https://vega-mainnet-data.commodum.io/api/v2/liquidity/provisions' \
-H 'Accept: application/json'

go / native

curl -L -X GET 'https://vega-mainnet-data.commodum.io/api/v2/liquidity/provisions' \
-H 'Accept: application/json'

nodejs / axios

curl -L -X GET 'https://vega-mainnet-data.commodum.io/api/v2/liquidity/provisions' \
-H 'Accept: application/json'