List liquidity providers data

GET 
/api/v2/liquidity/providers

List information about active liquidity provider(s) for a given market, or liquidity provider's party ID.

Request

Query Parameters

marketId string

Market ID to retrieve liquidity providers for. If omitted, you must provide a party ID.

partyId string

Party ID to retrieve data for. If omitted, you must provide a market ID.

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

liquidityProviders object

Page of liquidity providers and corresponding page information.

edges object[]

Page of liquidity provider data.

Array [

cursor string

Cursor that can be used to fetch further data.

node object

Liquidity provider information returned by the API.

feeShare object

Information used for calculating an LP's fee share, such as the equity like share, average entry valuation and liquidity score for the liquidity provider for the specified market.

averageEntryValuation string

Average entry valuation of the liquidity provider for the market.

averageScore string

Average liquidity score.

equityLikeShare string

Share own by this liquidity provider.

party string

Liquidity provider party ID.

virtualStake string

The virtual stake of this liquidity provider.

marketId string

ID of the market the liquidity provider is active in.

partyId string

Party ID of the liquidity provider.

sla object

Information about LP's SLA performance.

currentEpochFractionOfTimeOnBook string

Indicates how often LP meets the commitment during the current epoch.

hysteresisPeriodFeePenalties string[]

Determines how the fee penalties from past epochs affect future fee revenue.

lastEpochBondPenalty string

Shows the bond penalties from past epochs.

lastEpochFeePenalty string

Indicates the fee penalty amount applied in the previous epoch.

lastEpochFractionOfTimeOnBook string

Indicates how often LP met the commitment in the previous epoch.

notionalVolumeBuys string

Notional volume of orders within the range provided on the buy side of the book.

notionalVolumeSells string

Notional volume of orders within the range provided on the sell side of the book.

party string

Liquidity provider party ID.

requiredLiquidity string

Represents the total amount of funds LP must supply. The amount to be supplied is in the market’s settlement currency, spread on both buy and sell sides of the order book within a defined range.

]

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.

Example (from schema)

{
  "liquidityProviders": {
    "edges": [
      {
        "cursor": "string",
        "node": {
          "feeShare": {
            "averageEntryValuation": "string",
            "averageScore": "string",
            "equityLikeShare": "string",
            "party": "string",
            "virtualStake": "string"
          },
          "marketId": "string",
          "partyId": "string",
          "sla": {
            "currentEpochFractionOfTimeOnBook": "string",
            "hysteresisPeriodFeePenalties": [
              "string"
            ],
            "lastEpochBondPenalty": "string",
            "lastEpochFeePenalty": "string",
            "lastEpochFractionOfTimeOnBook": "string",
            "notionalVolumeBuys": "string",
            "notionalVolumeSells": "string",
            "party": "string",
            "requiredLiquidity": "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...