AppXDiscordTelegram

User

get

Checks compliance for a user and retrieves predicate message if compliant

Path parameters
addressstringRequired

User address

Example: 0x1234567890123456789012345678901234567890Pattern: ^0x[a-fA-F0-9]{40}$
Query parameters
chainIdnumberOptional

Optional. Chain ID

Default: 1Example: 1
isDepositAndBridgestringOptional

Optional. Indicates if the compliance check is for deposit and bridge interaction. Defaults to false.

Default: falseExample: false
isZapperstringOptional

Optional. Indicates if bridge uses zapper (usdt -> usdc swap). Defaults to false.

Default: falseExample: false
Responses
200

Compliance

application/json
get
/user/{address}/compliance
GET /v1/user/{address}/compliance HTTP/1.1
Host: api.nest.credit
Accept: */*

{
  "data": {
    "isCompliant": true,
    "predicateMessage": {
      "taskId": "text",
      "expireByBlockNumber": 1,
      "signerAddresses": [
        "text"
      ],
      "signatures": [
        "text"
      ]
    }
  }
}
get

Gets lifetime earnings for a user in a specific vault

Path parameters
addressstringRequired

User address

Example: 0x1234567890123456789012345678901234567890Pattern: ^0x[a-fA-F0-9]{40}$
slugstringRequired

Vault slug identifier

Example: nest-alpha-vault
Responses
200

Lifetime earnings data

application/json
get
/user/{address}/vaults/{slug}/lifetimeEarnings
GET /v1/user/{address}/vaults/{slug}/lifetimeEarnings HTTP/1.1
Host: api.nest.credit
Accept: */*

{
  "data": {
    "lifetimeEarnings": 1
  }
}
get

Gets aggregated lifetime earnings for a user across all vaults

Path parameters
addressstringRequired

User address

Example: 0x1234567890123456789012345678901234567890Pattern: ^0x[a-fA-F0-9]{40}$
Responses
200

Total lifetime earnings on all vaults for a user

application/json
get
/user/{address}/lifetimeEarnings
GET /v1/user/{address}/lifetimeEarnings HTTP/1.1
Host: api.nest.credit
Accept: */*

{
  "data": {
    "lifetimeEarnings": 1
  }
}
PreviousAssetsNextUser History

Last updated