Sign in
Opportunities

List Opportunities By Distributor

Changed on

Returns active opportunities visible to a distributor (per its earn details configuration), with the same pagination, filtering and sorting as /opportunities.

get/v2/opportunities/distributors/{distributorId}

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

distributorIdstring required

Distributor ID whose earn details config scopes the results

Query parameters

pageinteger
limitinteger
pageLimitinteger
pageSizeinteger
searchstring

Case-insensitive match on name, description or token address

chainIdsstring

Comma-separated numeric chain IDs (deposit tokens), e.g. '1,43114'

depositTokenstring

Deposit token in 'address-chainId' format, e.g. '0xb31f...-43114'

depositTokenSymbolsstring

Comma-separated deposit token symbols (case-insensitive, OR logic)

tagsstring

Comma-separated tag codes

curatorIdstring

Comma-separated curator organization ids

providerIdstring

Comma-separated provider organization ids

partnerIdstring

Comma-separated partner organization ids

lendingProtocolIdstring

Comma-separated lending protocol organization ids

tvlMinnumber

Minimum TVL in USD

tvlMaxnumber

Maximum TVL in USD

minAprnumber

Minimum estimated APR

maxAprnumber

Maximum estimated APR

featuredboolean nullable

Filter by featured flag

directInteractionEnabledboolean

When true, only opportunities with direct interaction enabled

routedSwapEnabledboolean

When true, only opportunities with routed swap entry enabled

depositEnabledboolean

When true, only opportunities with deposits enabled

withdrawEnabledboolean

When true, only opportunities with withdrawals enabled

asyncDepositboolean

When true, only opportunities with asynchronous deposits

asyncWithdrawboolean

When true, only opportunities with asynchronous withdrawals

includeDeltasboolean

When true, include each opportunity's TVL, LP count and APY with their movement over the trailing day, week and month

sortBystring

One of: tvl, name, type, apr, curator, provider (defaults to tvl)

sortOrderstring

asc or desc (defaults to desc)

Response

OK

Example response

{
  "data": [
    {
      "curator": {
        "id": "248df4b7-aa70-47b8-a036-33ac447e668d"
      },
      "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "incentives": [
        {
          "id": "248df4b7-aa70-47b8-a036-33ac447e668d"
        }
      ]
    }
  ]
}

Changes

  • v20b89de4dded7Revision changes
    • info

      added the new optional query request parameter includeDeltas

    • info

      added the optional property // to the response with the status

  • v260527ba59276Revision changes
    • info

      added the new optional query request parameter pageLimit

    • info

      added the new optional query request parameter pageSize

    • info

      added the optional property / to the response with the status