Lend and Borrow Campaign (Aave)

This page specifies the API for retrieving details about Lend/Borrow campaigns for the Aave protocol.

Endpoint

POST https://incentra-prd.brevis.network/sdk/v1/aaveCampaigns

Request

Field	Type	Description
`chain_id`	`[uint64]`	Chain ID(s) where the targeted Aave vault is deployed.
`atoken_address`	`[string]`	List of targeted Aave atoken contract addresses.
`action`	`[uint64]`	Filter by campaign action type: `lend: 5001`, `borrow: 5002` , `lend_net: 5003`.
`campaign_id`	`[string]`	List of specific campaign IDs to retrieve.
`status`	`[CampaignStatus]`	Filter by campaign status (enum will be specified later)
`user_address`	`[string]`	Retrieve campaigns where the specified user address(es) has participated.

If any filter is not specified, it means there is no constraint for this filter.

CampaignStatus Enum

The CampaignStatus enum has the following values:

DEPLOYING
CREATING_FAILED
INACTIVE
ACTIVE
ENDED
DEACTIVATED

Response

Field	Type	Description
`err`	`ErrMsg`	Error message if request fails.
`campaigns`	`[AaveCampaignInfo]`	List of Aave campaign details.

AaveCampaignInfo Fields

Field	Type	Description
`chain_id`	`uint64`	Chain ID where the targeted Aave atoken is deployed.
`vault_address`	`string`	Aave atoken address.
`action`	`uint64`	Campaign action type: `lend: 5001`, `borrow: 5002` , `lend_net: 5003`.
`campaign_id`	`string`	Unique identifier for the campaign.
`campaign_name`	`string`	Campaign display name
`start_time`	`uint64`	Campaign start timestamp.
`end_time`	`uint64`	Campaign end timestamp.
`reward_info`	`RewardInfo`	Details about the reward token and amount. See `RewardInfo` below.
`last_reward_attestation_time`	`uint64`	Last campaign reward attestation timestamp.
`status`	`CampaignStatus`	Current status of the campaign. See `CampaignStatus` enum.

RewardInfo Fields

Field	Type	Description
`submission_chain_id`	`uint64`	Campaign reward submission chain ID (see on-chain reward claim for details).
`submission_contract`	`string`	Campaign reward submission contract address (see on-chain reward claim for details)
`claim_chain_id`	`uint64`	Chain ID where rewards can be claimed.
`claim_contract`	`string`	Reward claim contract address.
`token_address`	`string`	Reward token address.
`token_symbol`	`string`	Reward token symbol.
`reward_amt`	`string`	Reward amount.
`reward_usd_price`	`string`	USD price for the reward token.
`reward_per_hour`	`string`	Reward amount distributed per hour.
`apr`	`float`	The APR of the campaign (for example, 0.03 means 3% APR)
`tvl`	`float`	The supply/borrow USD value of the vault

Post Example (curl)

{
    "chain_id": [
        1,
        42161
    ],
    "atoken_address": [
        "0x4d5F47FA6A74757f35C14fD3a6Ef8E3C9BC514E8"
    ],
    "campaign_id": [

    ],
    "status": [
        4
    ],
    "user_address": [],
    "action": [
        5001,
        5002,
        5003
    ]
}

post with data.json:

curl -X POST -H "Content-Type: application/json" -d @data.json POST https://incentra-prd.brevis.network/sdk/v1/aaveCampaigns

Keyboard shortcuts

Brevis Incentra

Lend and Borrow Campaign (Aave)

Endpoint

Request

Response

Post Example (curl)