List Yield Claims

curl --request GET \
  --url https://api.caminotreasury.com/v1/yield/{address} \
  --header 'x-api-key: <api-key>'

{
  "data": [
    {
      "chainId": 123,
      "distributor": "<string>",
      "periodId": "<string>",
      "root": "<string>",
      "index": 123,
      "account": "<string>",
      "amount": "<string>",
      "proof": [
        "<string>"
      ]
    }
  ],
  "count": 123
}

Yield

List Yield Claims

Returns the holder’s YieldDistributor merkle claims as a flat list. Each entry is self-contained — it carries its own chainId and distributor address — so it can be passed directly into the corresponding contract’s claim(). Sorted by periodId ascending. Each entry’s status is claimed (already pulled on-chain) or unclaimed (finalized and within the claim window). Periods that are unpublished, still in the operator replace window, or expired-without-claim are omitted. When chainId is omitted, results cover every configured chain that has a deployed YieldDistributor.

GET

yield

{address}

List Yield Claims

curl --request GET \
  --url https://api.caminotreasury.com/v1/yield/{address} \
  --header 'x-api-key: <api-key>'

{
  "data": [
    {
      "chainId": 123,
      "distributor": "<string>",
      "periodId": "<string>",
      "root": "<string>",
      "index": 123,
      "account": "<string>",
      "amount": "<string>",
      "proof": [
        "<string>"
      ]
    }
  ],
  "count": 123
}

Authorizations

x-api-key

string

header

required

API key for authentication. Pass your key in the x-api-key header.

Path Parameters

address

string

required

0x-address of the holder to look up.

Pattern: ^0x[a-fA-F0-9]{40}$

Query Parameters

chainId

integer

Restrict the response to a single chain. Defaults to returning entries from every chain the server is configured for.

Required range: x >= 1

Response

Claimed and unclaimed entries for the holder.

data

object[]

required

One entry per (chain, period) the holder appears in — sorted by periodId ascending. Unpublished, unfinalized, and expired-without-claim periods are omitted.

Show child attributes

count

integer

required

Length of data.

Update Recipient

Get Period Artifact