Steer Protocol API Documentation
API documentation for the Steer Protocol
API Endpoints
https://s55qpiwei1.execute-api.us-east-1.amazonaws.com
Version
1.0.0
Queries
campaign
Example
Query
query campaign($id: ID!) {
campaign(id: $id) {
id
pool {
...PoolFragment
}
rewardToken {
...TokenFragment
}
metaData {
...CampaignMetaDataFragment
}
apr {
...CampaignAPRDataFragment
}
creator
startBlock
endBlock
distributionAmount
abandonedDeadline
cumulativeAllocated
liquidityPool
lastBlockUpdatedTo
paused
closed
campaignStartTimestamp
campaignEndTimestamp
ipfsHash
chainId
ponderDbIdentifier
executionBundle
executionParams
desc
createdAt
updatedAt
campaignEventId
campaignType
name
protocol
campaignId
vaults {
...VaultFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"campaign": {
"id": "4",
"pool": Pool,
"rewardToken": Token,
"metaData": CampaignMetaData,
"apr": CampaignAPRData,
"creator": "abc123",
"startBlock": 123,
"endBlock": 987,
"distributionAmount": "abc123",
"abandonedDeadline": 987,
"cumulativeAllocated": 123,
"liquidityPool": "abc123",
"lastBlockUpdatedTo": 123,
"paused": true,
"closed": true,
"campaignStartTimestamp": "2007-12-03T10:15:30Z",
"campaignEndTimestamp": "2007-12-03T10:15:30Z",
"ipfsHash": "xyz789",
"chainId": 987,
"ponderDbIdentifier": "abc123",
"executionBundle": "xyz789",
"executionParams": "abc123",
"desc": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"campaignEventId": "xyz789",
"campaignType": "abc123",
"name": "xyz789",
"protocol": "xyz789",
"campaignId": 987,
"vaults": [Vault]
}
}
}
campaignAPR
Response
Returns [CampaignAPR!]!
Example
Query
query campaignAPR {
campaignAPR {
campaignId
chainId
vault
apr1d
apr7d
apr14d
latestToken0Usd
latestToken1Usd
latestTvlUsd
calculationTimestamp
}
}
Response
{
"data": {
"campaignAPR": [
{
"campaignId": 987,
"chainId": 987,
"vault": "xyz789",
"apr1d": 987.65,
"apr7d": 123.45,
"apr14d": 123.45,
"latestToken0Usd": 987.65,
"latestToken1Usd": 123.45,
"latestTvlUsd": 987.65,
"calculationTimestamp": "2007-12-03T10:15:30Z"
}
]
}
}
campaignAPRV2ById
Response
Returns [CampaignAPRV2]
Arguments
Name | Description |
---|---|
campaignId - Int!
|
|
chainId - Int!
|
|
poolAddress - String!
|
|
vaultAddresses - [String!]!
|
Example
Query
query campaignAPRV2ById(
$campaignId: Int!,
$chainId: Int!,
$poolAddress: String!,
$vaultAddresses: [String!]!
) {
campaignAPRV2ById(
campaignId: $campaignId,
chainId: $chainId,
poolAddress: $poolAddress,
vaultAddresses: $vaultAddresses
) {
campaignId
chainId
vault
apr1d
apr7d
apr14d
latestToken0Usd
latestToken1Usd
latestTvlUsd
calculationTimestamp
}
}
Variables
{
"campaignId": 987,
"chainId": 987,
"poolAddress": "xyz789",
"vaultAddresses": ["abc123"]
}
Response
{
"data": {
"campaignAPRV2ById": [
{
"campaignId": 123,
"chainId": 123,
"vault": "xyz789",
"apr1d": 123.45,
"apr7d": 987.65,
"apr14d": 987.65,
"latestToken0Usd": 987.65,
"latestToken1Usd": 987.65,
"latestTvlUsd": 123.45,
"calculationTimestamp": "2007-12-03T10:15:30Z"
}
]
}
}
campaignAPRV2ByVault
Response
Returns an CampaignAPRV2
Arguments
Name | Description |
---|---|
vault - String!
|
|
chainId - Int!
|
|
poolAddress - String!
|
|
vaultAddresses - [String!]!
|
Example
Query
query campaignAPRV2ByVault(
$vault: String!,
$chainId: Int!,
$poolAddress: String!,
$vaultAddresses: [String!]!
) {
campaignAPRV2ByVault(
vault: $vault,
chainId: $chainId,
poolAddress: $poolAddress,
vaultAddresses: $vaultAddresses
) {
campaignId
chainId
vault
apr1d
apr7d
apr14d
latestToken0Usd
latestToken1Usd
latestTvlUsd
calculationTimestamp
}
}
Variables
{
"vault": "xyz789",
"chainId": 123,
"poolAddress": "xyz789",
"vaultAddresses": ["xyz789"]
}
Response
{
"data": {
"campaignAPRV2ByVault": {
"campaignId": 987,
"chainId": 987,
"vault": "abc123",
"apr1d": 123.45,
"apr7d": 123.45,
"apr14d": 123.45,
"latestToken0Usd": 123.45,
"latestToken1Usd": 123.45,
"latestTvlUsd": 123.45,
"calculationTimestamp": "2007-12-03T10:15:30Z"
}
}
}
campaignAPRsV2
Response
Returns [CampaignAPRV2!]!
Arguments
Name | Description |
---|---|
chainId - Int!
|
|
poolAddress - String!
|
|
vaultAddresses - [String!]!
|
Example
Query
query campaignAPRsV2(
$chainId: Int!,
$poolAddress: String!,
$vaultAddresses: [String!]!
) {
campaignAPRsV2(
chainId: $chainId,
poolAddress: $poolAddress,
vaultAddresses: $vaultAddresses
) {
campaignId
chainId
vault
apr1d
apr7d
apr14d
latestToken0Usd
latestToken1Usd
latestTvlUsd
calculationTimestamp
}
}
Variables
{
"chainId": 987,
"poolAddress": "abc123",
"vaultAddresses": ["xyz789"]
}
Response
{
"data": {
"campaignAPRsV2": [
{
"campaignId": 987,
"chainId": 987,
"vault": "abc123",
"apr1d": 987.65,
"apr7d": 123.45,
"apr14d": 987.65,
"latestToken0Usd": 123.45,
"latestToken1Usd": 123.45,
"latestTvlUsd": 123.45,
"calculationTimestamp": "2007-12-03T10:15:30Z"
}
]
}
}
campaigns
Response
Returns a CampaignConnection!
Arguments
Name | Description |
---|---|
first - Int
|
|
after - String
|
|
orderBy - OrderByInput
|
|
filter - CampaignFilter
|
Example
Query
query campaigns(
$first: Int,
$after: String,
$orderBy: OrderByInput,
$filter: CampaignFilter
) {
campaigns(
first: $first,
after: $after,
orderBy: $orderBy,
filter: $filter
) {
edges {
...CampaignEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"after": "abc123",
"orderBy": OrderByInput,
"filter": CampaignFilter
}
Response
{
"data": {
"campaigns": {
"edges": [CampaignEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
campaignsByPool
Response
Returns [Campaign]
Example
Query
query campaignsByPool(
$pool: String!,
$chainId: Int!
) {
campaignsByPool(
pool: $pool,
chainId: $chainId
) {
id
pool {
...PoolFragment
}
rewardToken {
...TokenFragment
}
metaData {
...CampaignMetaDataFragment
}
apr {
...CampaignAPRDataFragment
}
creator
startBlock
endBlock
distributionAmount
abandonedDeadline
cumulativeAllocated
liquidityPool
lastBlockUpdatedTo
paused
closed
campaignStartTimestamp
campaignEndTimestamp
ipfsHash
chainId
ponderDbIdentifier
executionBundle
executionParams
desc
createdAt
updatedAt
campaignEventId
campaignType
name
protocol
campaignId
vaults {
...VaultFragment
}
}
}
Variables
{"pool": "abc123", "chainId": 987}
Response
{
"data": {
"campaignsByPool": [
{
"id": 4,
"pool": Pool,
"rewardToken": Token,
"metaData": CampaignMetaData,
"apr": CampaignAPRData,
"creator": "abc123",
"startBlock": 987,
"endBlock": 987,
"distributionAmount": "xyz789",
"abandonedDeadline": 123,
"cumulativeAllocated": 123,
"liquidityPool": "xyz789",
"lastBlockUpdatedTo": 987,
"paused": false,
"closed": true,
"campaignStartTimestamp": "2007-12-03T10:15:30Z",
"campaignEndTimestamp": "2007-12-03T10:15:30Z",
"ipfsHash": "abc123",
"chainId": 987,
"ponderDbIdentifier": "xyz789",
"executionBundle": "abc123",
"executionParams": "xyz789",
"desc": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"campaignEventId": "abc123",
"campaignType": "abc123",
"name": "xyz789",
"protocol": "abc123",
"campaignId": 123,
"vaults": [Vault]
}
]
}
}
checkSignature
Response
Returns a SignatureCheckResult!
Arguments
Name | Description |
---|---|
address - String!
|
Example
Query
query checkSignature($address: String!) {
checkSignature(address: $address) {
exists
}
}
Variables
{"address": "xyz789"}
Response
{"data": {"checkSignature": {"exists": true}}}
claimProof
Response
Returns a ClaimProof
Arguments
Name | Description |
---|---|
id - ID!
|
Example
Query
query claimProof($id: ID!) {
claimProof(id: $id) {
chainId
lastBlockUpdatedTo
user
campaignId
amount
proof
}
}
Variables
{"id": "4"}
Response
{
"data": {
"claimProof": {
"chainId": 987,
"lastBlockUpdatedTo": 987,
"user": "xyz789",
"campaignId": 987,
"amount": {},
"proof": ["xyz789"]
}
}
}
claimProofs
Response
Returns a ClaimProofConnection!
Arguments
Name | Description |
---|---|
first - Int
|
|
after - String
|
|
orderBy - OrderByInput
|
|
filter - ClaimProofFilter
|
|
user - String!
|
Example
Query
query claimProofs(
$first: Int,
$after: String,
$orderBy: OrderByInput,
$filter: ClaimProofFilter,
$user: String!
) {
claimProofs(
first: $first,
after: $after,
orderBy: $orderBy,
filter: $filter,
user: $user
) {
edges {
...ClaimProofEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"after": "xyz789",
"orderBy": OrderByInput,
"filter": ClaimProofFilter,
"user": "abc123"
}
Response
{
"data": {
"claimProofs": {
"edges": [ClaimProofEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
claimRewards
Response
Returns a ClaimRewardConnection!
Arguments
Name | Description |
---|---|
poolId - String!
|
|
chainId - Int!
|
|
first - Int
|
|
after - String
|
|
orderBy - OrderByInput
|
|
filter - ClaimRewardFilter
|
Example
Query
query claimRewards(
$poolId: String!,
$chainId: Int!,
$first: Int,
$after: String,
$orderBy: OrderByInput,
$filter: ClaimRewardFilter
) {
claimRewards(
poolId: $poolId,
chainId: $chainId,
first: $first,
after: $after,
orderBy: $orderBy,
filter: $filter
) {
edges {
...ClaimRewardEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"poolId": "abc123",
"chainId": 123,
"first": 987,
"after": "abc123",
"orderBy": OrderByInput,
"filter": ClaimRewardFilter
}
Response
{
"data": {
"claimRewards": {
"edges": [ClaimRewardEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
historicalRewards
Response
Returns a HistoricalRewardsConnection!
Arguments
Name | Description |
---|---|
first - Int
|
|
after - String
|
|
orderBy - OrderByInput
|
|
filter - HistoricalRewardsFilter
|
Example
Query
query historicalRewards(
$first: Int,
$after: String,
$orderBy: OrderByInput,
$filter: HistoricalRewardsFilter
) {
historicalRewards(
first: $first,
after: $after,
orderBy: $orderBy,
filter: $filter
) {
edges {
...HistoricalRewardsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"after": "xyz789",
"orderBy": OrderByInput,
"filter": HistoricalRewardsFilter
}
Response
{
"data": {
"historicalRewards": {
"edges": [HistoricalRewardsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
ponderDeploymentConfig
Response
Returns a PonderDeploymentConfig
Arguments
Name | Description |
---|---|
id - UUID!
|
Example
Query
query ponderDeploymentConfig($id: UUID!) {
ponderDeploymentConfig(id: $id) {
id
steerVaults
uniswapPools
vaultRegistry
startBlock
network
status
createdAt
updatedAt
dbIdentifier
steerPeriphery
poolHelper
poolHelperBlockNumber
protocol
chainId
health {
...HealthDataFragment
}
ponderType
tokens
}
}
Variables
{
"id": "6aeb3488-3c95-4337-b29a-73aad5142e1a"
}
Response
{
"data": {
"ponderDeploymentConfig": {
"id": "6aeb3488-3c95-4337-b29a-73aad5142e1a",
"steerVaults": {},
"uniswapPools": {},
"vaultRegistry": "abc123",
"startBlock": 987,
"network": "abc123",
"status": false,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"dbIdentifier": "abc123",
"steerPeriphery": "xyz789",
"poolHelper": "abc123",
"poolHelperBlockNumber": 987,
"protocol": "abc123",
"chainId": "xyz789",
"health": HealthData,
"ponderType": "abc123",
"tokens": {}
}
}
}
ponderDeploymentConfigs
Response
Returns a PonderDeploymentConfigConnection!
Arguments
Name | Description |
---|---|
first - Int
|
|
after - String
|
|
orderBy - OrderByInput
|
|
filter - PonderDeploymentFilter
|
Example
Query
query ponderDeploymentConfigs(
$first: Int,
$after: String,
$orderBy: OrderByInput,
$filter: PonderDeploymentFilter
) {
ponderDeploymentConfigs(
first: $first,
after: $after,
orderBy: $orderBy,
filter: $filter
) {
edges {
...PonderDeploymentConfigEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"after": "abc123",
"orderBy": OrderByInput,
"filter": PonderDeploymentFilter
}
Response
{
"data": {
"ponderDeploymentConfigs": {
"edges": [PonderDeploymentConfigEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
pool
Example
Query
query pool(
$id: ID!,
$chainId: Int!
) {
pool(
id: $id,
chainId: $chainId
) {
id
chainId
feeTier
token0 {
...TokenFragment
}
token1 {
...TokenFragment
}
}
}
Variables
{"id": "4", "chainId": 987}
Response
{
"data": {
"pool": {
"id": 4,
"chainId": 987,
"feeTier": "xyz789",
"token0": Token,
"token1": Token
}
}
}
poolRewards
Response
Returns [PublishedReward]
Example
Query
query poolRewards(
$poolId: String!,
$chainId: Int!
) {
poolRewards(
poolId: $poolId,
chainId: $chainId
) {
id
user
claimAmount
campaignId
lastBlockUpdated
chainId
createdAt
updatedAt
}
}
Variables
{"poolId": "xyz789", "chainId": 123}
Response
{
"data": {
"poolRewards": [
{
"id": 123,
"user": "xyz789",
"claimAmount": "xyz789",
"campaignId": 123,
"lastBlockUpdated": 987,
"chainId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
pools
Response
Returns a PoolConnection!
Arguments
Name | Description |
---|---|
first - Int
|
|
after - String
|
|
orderBy - OrderByInput
|
|
filter - PoolFilter
|
Example
Query
query pools(
$first: Int,
$after: String,
$orderBy: OrderByInput,
$filter: PoolFilter
) {
pools(
first: $first,
after: $after,
orderBy: $orderBy,
filter: $filter
) {
edges {
...PoolEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"after": "xyz789",
"orderBy": OrderByInput,
"filter": PoolFilter
}
Response
{
"data": {
"pools": {
"edges": [PoolEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
resolveIp
Response
Returns an IPData!
Example
Query
query resolveIp {
resolveIp {
ip
country_code
country_name
region_code
region_name
city
zip_code
latitude
longitude
}
}
Response
{
"data": {
"resolveIp": {
"ip": "abc123",
"country_code": "abc123",
"country_name": "abc123",
"region_code": "xyz789",
"region_name": "xyz789",
"city": "abc123",
"zip_code": "abc123",
"latitude": 123.45,
"longitude": 123.45
}
}
}
rewardByCampaignId
Response
Returns a CampaignRewards
Arguments
Name | Description |
---|---|
id - String!
|
Example
Query
query rewardByCampaignId($id: String!) {
rewardByCampaignId(id: $id) {
totalPendingClaimAmount
totalPublishedClaimAmount
totalUserClaimedAmount
totalInProcessClaimAmount
campaign {
...CampaignFragment
}
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"rewardByCampaignId": {
"totalPendingClaimAmount": "xyz789",
"totalPublishedClaimAmount": "abc123",
"totalUserClaimedAmount": "abc123",
"totalInProcessClaimAmount": "xyz789",
"campaign": Campaign
}
}
}
rewardToken
Response
Returns a RewardTokenAmount
Arguments
Name | Description |
---|---|
id - String!
|
Example
Query
query rewardToken($id: String!) {
rewardToken(id: $id) {
id
token
chainId
minRewardAmount
smartRewarderAddress
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"rewardToken": {
"id": "abc123",
"token": "abc123",
"chainId": {},
"minRewardAmount": {},
"smartRewarderAddress": "xyz789"
}
}
}
rewardTokens
Response
Returns a RewardTokenConnection!
Arguments
Name | Description |
---|---|
first - Int
|
|
after - String
|
|
orderBy - OrderByInput
|
|
filter - RewardTokenFilter
|
Example
Query
query rewardTokens(
$first: Int,
$after: String,
$orderBy: OrderByInput,
$filter: RewardTokenFilter
) {
rewardTokens(
first: $first,
after: $after,
orderBy: $orderBy,
filter: $filter
) {
edges {
...RewardTokenEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"after": "abc123",
"orderBy": OrderByInput,
"filter": RewardTokenFilter
}
Response
{
"data": {
"rewardTokens": {
"edges": [RewardTokenEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
rewards
Response
Returns a Rewards!
Example
Query
query rewards {
rewards {
campaignRewards {
...CampaignRewardsFragment
}
}
}
Response
{
"data": {
"rewards": {"campaignRewards": [CampaignRewards]}
}
}
smartRewarderContracts
Response
Returns [SmartRewarderContract!]!
Example
Query
query smartRewarderContracts {
smartRewarderContracts {
address
chainId
blocksPerDay
}
}
Response
{
"data": {
"smartRewarderContracts": [
{
"address": "abc123",
"chainId": 987,
"blocksPerDay": 987
}
]
}
}
strategies
Response
Returns a StrategyConnection!
Arguments
Name | Description |
---|---|
first - Int
|
|
after - String
|
|
orderBy - OrderByInput
|
|
filter - StrategyFilter
|
Example
Query
query strategies(
$first: Int,
$after: String,
$orderBy: OrderByInput,
$filter: StrategyFilter
) {
strategies(
first: $first,
after: $after,
orderBy: $orderBy,
filter: $filter
) {
edges {
...StrategyEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"after": "xyz789",
"orderBy": OrderByInput,
"filter": StrategyFilter
}
Response
{
"data": {
"strategies": {
"edges": [StrategyEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
strategy
Example
Query
query strategy(
$id: ID!,
$chainId: Int!
) {
strategy(
id: $id,
chainId: $chainId
) {
id
chainId
nftId
name
createdAt
admin
creator
executionBundle
}
}
Variables
{"id": "4", "chainId": 123}
Response
{
"data": {
"strategy": {
"id": "4",
"chainId": 123,
"nftId": 987,
"name": "abc123",
"createdAt": 123,
"admin": "xyz789",
"creator": "abc123",
"executionBundle": "abc123"
}
}
}
token
Example
Query
query token($id: ID!) {
token(id: $id) {
id
symbol
name
decimals
chainId
address
pools {
...PoolFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"token": {
"id": "4",
"symbol": "xyz789",
"name": "abc123",
"decimals": 123,
"chainId": 987,
"address": "abc123",
"pools": [Pool]
}
}
}
tokens
Response
Returns a TokenConnection!
Arguments
Name | Description |
---|---|
first - Int
|
|
after - String
|
|
orderBy - OrderByInput
|
|
filter - TokenFilter
|
Example
Query
query tokens(
$first: Int,
$after: String,
$orderBy: OrderByInput,
$filter: TokenFilter
) {
tokens(
first: $first,
after: $after,
orderBy: $orderBy,
filter: $filter
) {
edges {
...TokenEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"after": "abc123",
"orderBy": OrderByInput,
"filter": TokenFilter
}
Response
{
"data": {
"tokens": {
"edges": [TokenEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
userBalances
Response
Returns a UserVaultBalances
Arguments
Name | Description |
---|---|
user - String!
|
Example
Query
query userBalances($user: String!) {
userBalances(user: $user) {
accountId
vaultBalances {
...VaultBalanceFragment
}
}
}
Variables
{"user": "xyz789"}
Response
{
"data": {
"userBalances": {
"accountId": "xyz789",
"vaultBalances": [VaultBalance]
}
}
}
userReward
Response
Returns a UserReward
Arguments
Name | Description |
---|---|
id - String!
|
Example
Query
query userReward($id: String!) {
userReward(id: $id) {
pendingRewards {
...PendingRewardFragment
}
publishedRewards {
...PublishedRewardFragment
}
userClaims {
...UserClaimFragment
}
user
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"userReward": {
"pendingRewards": [PendingReward],
"publishedRewards": [PublishedReward],
"userClaims": [UserClaim],
"user": "xyz789"
}
}
}
userRewards
Response
Returns a UserRewardConnection!
Arguments
Name | Description |
---|---|
first - Int
|
|
after - String
|
|
orderBy - OrderByInput
|
|
filter - UserRewardFilter
|
Example
Query
query userRewards(
$first: Int,
$after: String,
$orderBy: OrderByInput,
$filter: UserRewardFilter
) {
userRewards(
first: $first,
after: $after,
orderBy: $orderBy,
filter: $filter
) {
edges {
...UserRewardEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"after": "xyz789",
"orderBy": OrderByInput,
"filter": UserRewardFilter
}
Response
{
"data": {
"userRewards": {
"edges": [UserRewardEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
userRewardsByCampaign
Response
Returns a UserReward
Example
Query
query userRewardsByCampaign(
$user: String!,
$campaignId: String!
) {
userRewardsByCampaign(
user: $user,
campaignId: $campaignId
) {
pendingRewards {
...PendingRewardFragment
}
publishedRewards {
...PublishedRewardFragment
}
userClaims {
...UserClaimFragment
}
user
}
}
Variables
{
"user": "abc123",
"campaignId": "xyz789"
}
Response
{
"data": {
"userRewardsByCampaign": {
"pendingRewards": [PendingReward],
"publishedRewards": [PublishedReward],
"userClaims": [UserClaim],
"user": "xyz789"
}
}
}
vault
Example
Query
query vault(
$id: ID!,
$chainId: Int!
) {
vault(
id: $id,
chainId: $chainId
) {
id
chainId
vaultAddress
token0 {
...TokenFragment
}
token1 {
...TokenFragment
}
pool {
...PoolFragment
}
protocol
beaconName
protocolBaseType
targetProtocol
name
campaigns {
...CampaignFragment
}
almPosition {
...PositionRollUpFragment
}
aprData {
...VaultAPRV2Fragment
}
}
}
Variables
{"id": 4, "chainId": 987}
Response
{
"data": {
"vault": {
"id": 4,
"chainId": 123,
"vaultAddress": "xyz789",
"token0": Token,
"token1": Token,
"pool": Pool,
"protocol": "xyz789",
"beaconName": "abc123",
"protocolBaseType": "abc123",
"targetProtocol": "xyz789",
"name": "xyz789",
"campaigns": [Campaign],
"almPosition": [PositionRollUp],
"aprData": VaultAPRV2
}
}
}
vaultAPRV2
Response
Returns an VaultAPRV2
Example
Query
query vaultAPRV2(
$vault: String!,
$chainId: Int!,
$poolAddress: String!
) {
vaultAPRV2(
vault: $vault,
chainId: $chainId,
poolAddress: $poolAddress
) {
vault
chainId
avgAprAllTime
apr1dAvg
apr7dAvg
apr14dAvg
}
}
Variables
{
"vault": "xyz789",
"chainId": 987,
"poolAddress": "xyz789"
}
Response
{
"data": {
"vaultAPRV2": {
"vault": "abc123",
"chainId": 987,
"avgAprAllTime": 123.45,
"apr1dAvg": 987.65,
"apr7dAvg": 123.45,
"apr14dAvg": 987.65
}
}
}
vaultAPRs
Response
Returns [VaultAPRs!]!
Example
Query
query vaultAPRs {
vaultAPRs {
vaultId
aprData {
...VaultAPRFragment
}
}
}
Response
{
"data": {
"vaultAPRs": [
{
"vaultId": "xyz789",
"aprData": [VaultAPR]
}
]
}
}
vaultAPRsV2
Response
Returns [VaultAPRV2!]!
Example
Query
query vaultAPRsV2 {
vaultAPRsV2 {
vault
chainId
avgAprAllTime
apr1dAvg
apr7dAvg
apr14dAvg
}
}
Response
{
"data": {
"vaultAPRsV2": [
{
"vault": "xyz789",
"chainId": 987,
"avgAprAllTime": 123.45,
"apr1dAvg": 987.65,
"apr7dAvg": 123.45,
"apr14dAvg": 987.65
}
]
}
}
vaults
Response
Returns a VaultConnection!
Arguments
Name | Description |
---|---|
first - Int
|
|
after - String
|
|
orderBy - OrderByInput
|
|
filter - VaultFilter
|
Example
Query
query vaults(
$first: Int,
$after: String,
$orderBy: OrderByInput,
$filter: VaultFilter
) {
vaults(
first: $first,
after: $after,
orderBy: $orderBy,
filter: $filter
) {
edges {
...VaultEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"after": "abc123",
"orderBy": OrderByInput,
"filter": VaultFilter
}
Response
{
"data": {
"vaults": {
"edges": [VaultEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
vaultsByCampaign
Example
Query
query vaultsByCampaign($campaignId: String!) {
vaultsByCampaign(campaignId: $campaignId) {
id
chainId
vaultAddress
token0 {
...TokenFragment
}
token1 {
...TokenFragment
}
pool {
...PoolFragment
}
protocol
beaconName
protocolBaseType
targetProtocol
name
campaigns {
...CampaignFragment
}
almPosition {
...PositionRollUpFragment
}
aprData {
...VaultAPRV2Fragment
}
}
}
Variables
{"campaignId": "xyz789"}
Response
{
"data": {
"vaultsByCampaign": [
{
"id": "4",
"chainId": 987,
"vaultAddress": "xyz789",
"token0": Token,
"token1": Token,
"pool": Pool,
"protocol": "xyz789",
"beaconName": "xyz789",
"protocolBaseType": "abc123",
"targetProtocol": "xyz789",
"name": "abc123",
"campaigns": [Campaign],
"almPosition": [PositionRollUp],
"aprData": VaultAPRV2
}
]
}
}
Mutations
hello
Response
Returns a String!
Example
Query
mutation hello {
hello
}
Response
{"data": {"hello": "xyz789"}}
verifySignature
Response
Returns a VerificationResult!
Arguments
Name | Description |
---|---|
input - VerifySignatureInput!
|
Example
Query
mutation verifySignature($input: VerifySignatureInput!) {
verifySignature(input: $input) {
success
data {
...ApprovalDataFragment
}
error
}
}
Variables
{"input": VerifySignatureInput}
Response
{
"data": {
"verifySignature": {
"success": false,
"data": ApprovalData,
"error": "abc123"
}
}
}
Types
ApprovalData
BigInt
Example
{}
Boolean
Description
The Boolean
scalar type represents true
or false
.
CacheControlScope
Values
Enum Value | Description |
---|---|
|
|
|
Example
"PUBLIC"
Campaign
Fields
Field Name | Description |
---|---|
id - ID!
|
|
pool - Pool
|
|
rewardToken - Token!
|
|
metaData - CampaignMetaData
|
|
apr - CampaignAPRData
|
|
creator - String!
|
|
startBlock - Int!
|
|
endBlock - Int!
|
|
distributionAmount - String
|
|
abandonedDeadline - Int!
|
|
cumulativeAllocated - Int!
|
|
liquidityPool - String
|
|
lastBlockUpdatedTo - Int!
|
|
paused - Boolean!
|
|
closed - Boolean!
|
|
campaignStartTimestamp - DateTime!
|
|
campaignEndTimestamp - DateTime!
|
|
ipfsHash - String!
|
|
chainId - Int!
|
|
ponderDbIdentifier - String!
|
|
executionBundle - String!
|
|
executionParams - String!
|
|
desc - String
|
|
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
campaignEventId - String
|
|
campaignType - String
|
|
name - String
|
|
protocol - String
|
|
campaignId - Int
|
|
vaults - [Vault!]
|
Example
{
"id": "4",
"pool": Pool,
"rewardToken": Token,
"metaData": CampaignMetaData,
"apr": CampaignAPRData,
"creator": "xyz789",
"startBlock": 123,
"endBlock": 123,
"distributionAmount": "xyz789",
"abandonedDeadline": 123,
"cumulativeAllocated": 123,
"liquidityPool": "abc123",
"lastBlockUpdatedTo": 987,
"paused": true,
"closed": true,
"campaignStartTimestamp": "2007-12-03T10:15:30Z",
"campaignEndTimestamp": "2007-12-03T10:15:30Z",
"ipfsHash": "abc123",
"chainId": 123,
"ponderDbIdentifier": "abc123",
"executionBundle": "abc123",
"executionParams": "abc123",
"desc": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"campaignEventId": "abc123",
"campaignType": "xyz789",
"name": "xyz789",
"protocol": "xyz789",
"campaignId": 987,
"vaults": [Vault]
}
CampaignAPR
Example
{
"campaignId": 987,
"chainId": 123,
"vault": "xyz789",
"apr1d": 123.45,
"apr7d": 123.45,
"apr14d": 123.45,
"latestToken0Usd": 123.45,
"latestToken1Usd": 987.65,
"latestTvlUsd": 123.45,
"calculationTimestamp": "2007-12-03T10:15:30Z"
}
CampaignAPRData
CampaignAPRV2
Description
Campaign APR V2 represents the Annual Percentage Rate (APR) for a campaign over different time periods
Fields
Field Name | Description |
---|---|
campaignId - Int!
|
The unique identifier of the campaign |
chainId - Int!
|
The chain ID where the campaign is deployed |
vault - String!
|
The vault address associated with the campaign |
apr1d - Float!
|
The APR calculated over the last 24 hours |
apr7d - Float!
|
The APR calculated over the last 7 days |
apr14d - Float!
|
The APR calculated over the last 14 days |
latestToken0Usd - Float!
|
The latest USD value of token0 in the vault |
latestToken1Usd - Float!
|
The latest USD value of token1 in the vault |
latestTvlUsd - Float!
|
The latest total USD value locked in the vault |
calculationTimestamp - DateTime!
|
The timestamp when the APR was calculated |
Example
{
"campaignId": 123,
"chainId": 123,
"vault": "xyz789",
"apr1d": 987.65,
"apr7d": 123.45,
"apr14d": 123.45,
"latestToken0Usd": 987.65,
"latestToken1Usd": 123.45,
"latestTvlUsd": 987.65,
"calculationTimestamp": "2007-12-03T10:15:30Z"
}
CampaignConnection
Fields
Field Name | Description |
---|---|
edges - [CampaignEdge!]!
|
|
pageInfo - PageInfo!
|
|
totalCount - Int!
|
Example
{
"edges": [CampaignEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
CampaignEdge
CampaignFilter
Fields
Input Field | Description |
---|---|
name - String
|
|
status - CampaignStatus
|
|
chainId - Int
|
Example
{
"name": "abc123",
"status": "ACTIVE",
"chainId": 987
}
CampaignMetaData
Example
{
"closed": 123,
"paused": 123,
"chainId": 987,
"endBlock": 123,
"campaignId": 987,
"startBlock": 987,
"abandonedDeadline": 123,
"distributionAmount": "abc123",
"lastBlockUpdatedTo": 123,
"cumulativeAllocated": 123,
"smartRewarderAddress": "xyz789"
}
CampaignRewards
Example
{
"totalPendingClaimAmount": "xyz789",
"totalPublishedClaimAmount": "abc123",
"totalUserClaimedAmount": "abc123",
"totalInProcessClaimAmount": "abc123",
"campaign": Campaign
}
CampaignStatus
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
Example
"ACTIVE"
ClaimProof
ClaimProofConnection
Fields
Field Name | Description |
---|---|
edges - [ClaimProofEdge!]!
|
|
pageInfo - PageInfo!
|
|
totalCount - Int!
|
Example
{
"edges": [ClaimProofEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
ClaimProofEdge
Fields
Field Name | Description |
---|---|
node - ClaimProof!
|
|
cursor - String!
|
Example
{
"node": ClaimProof,
"cursor": "xyz789"
}
ClaimProofFilter
ClaimReward
ClaimRewardConnection
Fields
Field Name | Description |
---|---|
edges - [ClaimRewardEdge!]!
|
|
pageInfo - PageInfo!
|
|
totalCount - Int!
|
Example
{
"edges": [ClaimRewardEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
ClaimRewardEdge
Fields
Field Name | Description |
---|---|
cursor - String!
|
|
node - ClaimReward!
|
Example
{
"cursor": "xyz789",
"node": ClaimReward
}
ClaimRewardFilter
Connection
Possible Types
Connection Types |
---|
Example
{
"edges": [Edge],
"pageInfo": PageInfo,
"totalCount": 987
}
DateTime
Example
"2007-12-03T10:15:30Z"
Edge
Float
Description
The Float
scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
HealthData
Fields
Field Name | Description |
---|---|
isRunning - Boolean
|
|
poolData - PoolData
|
|
vaultData - VaultData
|
|
position - Position
|
|
transaction - Transaction
|
Example
{
"isRunning": false,
"poolData": PoolData,
"vaultData": VaultData,
"position": Position,
"transaction": Transaction
}
HistoricalRewardsConnection
Fields
Field Name | Description |
---|---|
edges - [HistoricalRewardsEdge!]!
|
|
pageInfo - PageInfo!
|
|
totalCount - Int!
|
Example
{
"edges": [HistoricalRewardsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
HistoricalRewardsEdge
Fields
Field Name | Description |
---|---|
node - UserRewards!
|
|
cursor - String!
|
Example
{
"node": UserRewards,
"cursor": "xyz789"
}
HistoricalRewardsFilter
ID
Description
The ID
scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4"
) or integer (such as 4
) input value will be accepted as an ID.
Example
4
IPData
Example
{
"ip": "abc123",
"country_code": "xyz789",
"country_name": "abc123",
"region_code": "abc123",
"region_name": "xyz789",
"city": "xyz789",
"zip_code": "xyz789",
"latitude": 123.45,
"longitude": 123.45
}
Int
Description
The Int
scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
123
JSON
Example
{}
LastUpdate
Node
OrderByInput
Fields
Input Field | Description |
---|---|
field - String!
|
|
direction - OrderDirection!
|
Example
{"field": "abc123", "direction": "ASC"}
OrderDirection
Values
Enum Value | Description |
---|---|
|
|
|
Example
"ASC"
PageInfo
PendingReward
Example
{
"id": 123,
"user": "abc123",
"claimAmount": "abc123",
"campaignId": 987,
"lastBlockUpdated": {},
"chainId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
PonderDeploymentConfig
Fields
Field Name | Description |
---|---|
id - UUID!
|
|
steerVaults - JSON!
|
|
uniswapPools - JSON!
|
|
vaultRegistry - String!
|
|
startBlock - Int!
|
|
network - String!
|
|
status - Boolean!
|
|
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
dbIdentifier - String
|
|
steerPeriphery - String
|
|
poolHelper - String
|
|
poolHelperBlockNumber - Int
|
|
protocol - String
|
|
chainId - String
|
|
health - HealthData
|
|
ponderType - String
|
|
tokens - JSON
|
Example
{
"id": "6aeb3488-3c95-4337-b29a-73aad5142e1a",
"steerVaults": {},
"uniswapPools": {},
"vaultRegistry": "xyz789",
"startBlock": 123,
"network": "abc123",
"status": true,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"dbIdentifier": "xyz789",
"steerPeriphery": "xyz789",
"poolHelper": "xyz789",
"poolHelperBlockNumber": 123,
"protocol": "abc123",
"chainId": "xyz789",
"health": HealthData,
"ponderType": "xyz789",
"tokens": {}
}
PonderDeploymentConfigConnection
Fields
Field Name | Description |
---|---|
edges - [PonderDeploymentConfigEdge!]!
|
|
pageInfo - PageInfo!
|
|
totalCount - Int!
|
Example
{
"edges": [PonderDeploymentConfigEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
PonderDeploymentConfigEdge
Fields
Field Name | Description |
---|---|
cursor - String!
|
|
node - PonderDeploymentConfig!
|
Example
{
"cursor": "xyz789",
"node": PonderDeploymentConfig
}
PonderDeploymentFilter
Pool
PoolConnection
Fields
Field Name | Description |
---|---|
edges - [PoolEdge!]!
|
|
pageInfo - PageInfo!
|
|
totalCount - Int!
|
Example
{
"edges": [PoolEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
PoolData
PoolEdge
PoolFilter
Position
PositionRollUp
Fields
Field Name | Description |
---|---|
id - ID!
|
|
pool - String!
|
|
protocol - String!
|
|
owner - String!
|
|
active - Int!
|
|
startBlock - BigInt!
|
|
endBlock - BigInt
|
|
liquidity - BigInt!
|
|
chainId - Int!
|
|
tickLower - BigInt!
|
|
tickUpper - BigInt!
|
|
token0Amount - BigInt!
|
|
token1Amount - BigInt!
|
|
feesEarnedToken0 - BigInt!
|
|
feesEarnedToken1 - BigInt!
|
|
lastFeeGrowthInside0X128 - BigInt!
|
|
lastFeeGrowthInside1X128 - BigInt!
|
|
nonce - Int!
|
|
blockNumber - Int!
|
|
logIndex - Int!
|
|
timestamp - Int!
|
|
startTimestamp - BigInt
|
|
endTimestamp - BigInt
|
Example
{
"id": "4",
"pool": "xyz789",
"protocol": "xyz789",
"owner": "abc123",
"active": 987,
"startBlock": {},
"endBlock": {},
"liquidity": {},
"chainId": 987,
"tickLower": {},
"tickUpper": {},
"token0Amount": {},
"token1Amount": {},
"feesEarnedToken0": {},
"feesEarnedToken1": {},
"lastFeeGrowthInside0X128": {},
"lastFeeGrowthInside1X128": {},
"nonce": 123,
"blockNumber": 123,
"logIndex": 123,
"timestamp": 987,
"startTimestamp": {},
"endTimestamp": {}
}
PublishedReward
Example
{
"id": 123,
"user": "abc123",
"claimAmount": "abc123",
"campaignId": 987,
"lastBlockUpdated": 123,
"chainId": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
RewardTokenAmount
RewardTokenConnection
Fields
Field Name | Description |
---|---|
edges - [RewardTokenEdge!]!
|
|
pageInfo - PageInfo!
|
|
totalCount - Int!
|
Example
{
"edges": [RewardTokenEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
RewardTokenEdge
Fields
Field Name | Description |
---|---|
cursor - String!
|
|
node - RewardTokenAmount!
|
Example
{
"cursor": "xyz789",
"node": RewardTokenAmount
}
RewardTokenFilter
Rewards
Fields
Field Name | Description |
---|---|
campaignRewards - [CampaignRewards]!
|
Example
{"campaignRewards": [CampaignRewards]}
SignatureCheckResult
Fields
Field Name | Description |
---|---|
exists - Boolean!
|
Example
{"exists": false}
SmartRewarderContract
Strategy
Example
{
"id": "4",
"chainId": 123,
"nftId": 987,
"name": "xyz789",
"createdAt": 123,
"admin": "xyz789",
"creator": "abc123",
"executionBundle": "xyz789"
}
StrategyConnection
Fields
Field Name | Description |
---|---|
edges - [StrategyEdge!]!
|
|
pageInfo - PageInfo!
|
|
totalCount - Int!
|
Example
{
"edges": [StrategyEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
StrategyEdge
StrategyFilter
String
Description
The String
scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"xyz789"
Token
TokenConnection
Fields
Field Name | Description |
---|---|
edges - [TokenEdge!]!
|
|
pageInfo - PageInfo!
|
|
totalCount - Int!
|
Example
{
"edges": [TokenEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
TokenEdge
TokenFilter
Transaction
UUID
Example
"6aeb3488-3c95-4337-b29a-73aad5142e1a"
UserClaim
Example
{
"id": "4",
"user": "abc123",
"token": "abc123",
"amount": "xyz789",
"campaign": "xyz789",
"totalCampaignClaimed": "xyz789",
"chainId": 123,
"smartRewarderAddress": "abc123",
"originalId": "xyz789",
"blockNumber": 987,
"logIndex": 123,
"timestamp": 123
}
UserReward
Fields
Field Name | Description |
---|---|
pendingRewards - [PendingReward!]!
|
|
publishedRewards - [PublishedReward!]!
|
|
userClaims - [UserClaim!]!
|
|
user - String
|
Example
{
"pendingRewards": [PendingReward],
"publishedRewards": [PublishedReward],
"userClaims": [UserClaim],
"user": "xyz789"
}
UserRewardConnection
Fields
Field Name | Description |
---|---|
edges - [UserRewardEdge!]!
|
|
pageInfo - PageInfo!
|
|
totalCount - Int!
|
Example
{
"edges": [UserRewardEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
UserRewardEdge
Fields
Field Name | Description |
---|---|
cursor - String!
|
|
node - UserReward!
|
Example
{
"cursor": "abc123",
"node": UserReward
}
UserRewardFilter
UserRewards
Example
{
"rewardToken": "xyz789",
"chainId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"campaignId": 123,
"user": "xyz789",
"timestamp": "2007-12-03T10:15:30Z",
"blockNumber": {},
"amount": {}
}
UserVaultBalances
Fields
Field Name | Description |
---|---|
accountId - String!
|
|
vaultBalances - [VaultBalance!]!
|
Example
{
"accountId": "xyz789",
"vaultBalances": [VaultBalance]
}
Vault
Fields
Field Name | Description |
---|---|
id - ID!
|
|
chainId - Int!
|
|
vaultAddress - String!
|
|
token0 - Token!
|
|
token1 - Token!
|
|
pool - Pool!
|
|
protocol - String!
|
|
beaconName - String!
|
|
protocolBaseType - String!
|
|
targetProtocol - String!
|
|
name - String!
|
|
campaigns - [Campaign!]
|
|
almPosition - [PositionRollUp!]
|
|
aprData - VaultAPRV2
|
Example
{
"id": 4,
"chainId": 123,
"vaultAddress": "abc123",
"token0": Token,
"token1": Token,
"pool": Pool,
"protocol": "xyz789",
"beaconName": "abc123",
"protocolBaseType": "abc123",
"targetProtocol": "xyz789",
"name": "xyz789",
"campaigns": [Campaign],
"almPosition": [PositionRollUp],
"aprData": VaultAPRV2
}
VaultAPR
Example
{
"samplingTime": "2007-12-03T10:15:30Z",
"timeframe": "abc123",
"vault": "abc123",
"totalPositionToken1": 987.65,
"totalFeesToken1": 123.45,
"apr": 987.65
}
VaultAPRV2
VaultAPRs
Fields
Field Name | Description |
---|---|
vaultId - String!
|
|
aprData - [VaultAPR!]!
|
Example
{
"vaultId": "abc123",
"aprData": [VaultAPR]
}
VaultBalance
VaultConnection
Fields
Field Name | Description |
---|---|
edges - [VaultEdge!]!
|
|
pageInfo - PageInfo!
|
|
totalCount - Int!
|
Example
{
"edges": [VaultEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
VaultData
Fields
Field Name | Description |
---|---|
totalVaults - Int
|
|
vaults - [String!]
|
|
lastUpdate - LastUpdate
|
Example
{
"totalVaults": 987,
"vaults": ["abc123"],
"lastUpdate": LastUpdate
}
VaultEdge
VaultFilter
VerificationResult
Fields
Field Name | Description |
---|---|
success - Boolean!
|
|
data - ApprovalData
|
|
error - String
|
Example
{
"success": true,
"data": ApprovalData,
"error": "abc123"
}