List paid liquidity fees data

GET 
/api/v2/liquidity/paidfees

List information about paid liquidity fees for a given market, or asset ID.

Request

Query Parameters

marketId string

Restrict fee data to those fees generated in the given market.

assetId string

Restrict fee statistics to those paid in the given asset.

epochSeq uint64

Epoch to get paid liquidity fee statistics for. If omitted, the last complete epoch is used.

partyIds string[]

Restrict fee data to those fees paid to the given parties.

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.

includeDerivedParties boolean

Whether to return all derived parties from AMMs for the given party. If used, party ID is required.

epochFrom uint64

Restrict paid liquidity fees to those from a given epoch.

epochTo uint64

Restrict paid liquidity fees to those up to a given epoch.

Responses

200

A successful response.

application/json

Schema

Schema

paidLiquidityFees object

Page of paid liquidity fees and corresponding page information.

edges object[]

Page of paid liquidity fees data.

Array [

cursor string

Cursor that can be used to fetch further data.

node object

Paid liquidity fees data returned by the API.

asset string

Settlement asset of the market.

epochSeq uint64

Epoch for which these stats where valid.

feesPaidPerParty object[]

Fees paid per party.

Array [

amount string

Amount received.

party string

Receiving party ID.

quantumAmount string

Amount value in quantum.

]

market string

Market the fees were paid in.

totalFeesPaid string

Total fees paid across all parties.

]

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)

{
  "paidLiquidityFees": {
    "edges": [
      {
        "cursor": "string",
        "node": {
          "asset": "string",
          "epochSeq": "string",
          "feesPaidPerParty": [
            {
              "amount": "string",
              "party": "string",
              "quantumAmount": "string"
            }
          ],
          "market": "string",
          "totalFeesPaid": "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...