Projects

Show all listings projects based on filters, showing votes for current season

get

Query parameters

userkeystringOptional

yearnumberOptional

periodnumberOptional

limitinteger · max: 100OptionalDefault: 50

offsetinteger · max: 2147483647OptionalDefault: 0

Responses

200

Successful response

application/json

totalnumberRequired

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get/projects

GET /api/v2/projects HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "projects": [
    {
      "id": 1,
      "userkey": "text",
      "status": "ACTIVE",
      "bannerImageUrl": "https://example.com",
      "isPromoted": true,
      "showArchived": true,
      "description": "text",
      "createdAt": "text",
      "updatedAt": "text",
      "user": {
        "id": 1,
        "profileId": 1,
        "displayName": "text",
        "username": "text",
        "avatarUrl": "https://example.com",
        "description": "text",
        "score": 1,
        "status": "ACTIVE",
        "userkeys": [
          "text"
        ],
        "xpTotal": 1,
        "xpStreakDays": 1,
        "xpRemovedDueToAbuse": true,
        "influenceFactor": 1,
        "influenceFactorPercentile": 1,
        "humanVerificationStatus": "REQUESTED",
        "validatorNftCount": 1,
        "links": {
          "profile": "https://example.com",
          "scoreBreakdown": "https://example.com"
        },
        "stats": {
          "holdingsWei": 1,
          "review": {
            "received": {
              "negative": 1,
              "neutral": 1,
              "positive": 1
            }
          },
          "vouch": {
            "given": {
              "amountWeiTotal": 1,
              "count": 1
            },
            "received": {
              "amountWeiTotal": 1,
              "count": 1
            }
          },
          "vouchTotals": [
            {
              "balance": {
                "given": 1,
                "received": 1
              },
              "count": {
                "given": 1,
                "received": 1
              },
              "token": {
                "address": "text",
                "decimals": 1,
                "id": "eth"
              }
            }
          ]
        }
      },
      "votes": {
        "bullish": {
          "topVoters": [
            {
              "id": 1,
              "profileId": 1,
              "displayName": "text",
              "username": "text",
              "avatarUrl": "https://example.com",
              "description": "text",
              "score": 1,
              "status": "ACTIVE",
              "userkeys": [
                "text"
              ],
              "xpTotal": 1,
              "xpStreakDays": 1,
              "xpRemovedDueToAbuse": true,
              "influenceFactor": 1,
              "influenceFactorPercentile": 1,
              "humanVerificationStatus": "REQUESTED",
              "validatorNftCount": 1,
              "links": {
                "profile": "https://example.com",
                "scoreBreakdown": "https://example.com"
              },
              "stats": {
                "holdingsWei": 1,
                "review": {
                  "received": {
                    "negative": 1,
                    "neutral": 1,
                    "positive": 1
                  }
                },
                "vouch": {
                  "given": {
                    "amountWeiTotal": 1,
                    "count": 1
                  },
                  "received": {
                    "amountWeiTotal": 1,
                    "count": 1
                  }
                },
                "vouchTotals": [
                  {
                    "balance": {
                      "given": 1,
                      "received": 1
                    },
                    "count": {
                      "given": 1,
                      "received": 1
                    },
                    "token": {
                      "address": "text",
                      "decimals": 1,
                      "id": "eth"
                    }
                  }
                ]
              }
            }
          ],
          "total": 1,
          "uniqueVoters": 1
        },
        "bearish": {
          "topVoters": [
            {
              "id": 1,
              "profileId": 1,
              "displayName": "text",
              "username": "text",
              "avatarUrl": "https://example.com",
              "description": "text",
              "score": 1,
              "status": "ACTIVE",
              "userkeys": [
                "text"
              ],
              "xpTotal": 1,
              "xpStreakDays": 1,
              "xpRemovedDueToAbuse": true,
              "influenceFactor": 1,
              "influenceFactorPercentile": 1,
              "humanVerificationStatus": "REQUESTED",
              "validatorNftCount": 1,
              "links": {
                "profile": "https://example.com",
                "scoreBreakdown": "https://example.com"
              },
              "stats": {
                "holdingsWei": 1,
                "review": {
                  "received": {
                    "negative": 1,
                    "neutral": 1,
                    "positive": 1
                  }
                },
                "vouch": {
                  "given": {
                    "amountWeiTotal": 1,
                    "count": 1
                  },
                  "received": {
                    "amountWeiTotal": 1,
                    "count": 1
                  }
                },
                "vouchTotals": [
                  {
                    "balance": {
                      "given": 1,
                      "received": 1
                    },
                    "count": {
                      "given": 1,
                      "received": 1
                    },
                    "token": {
                      "address": "text",
                      "decimals": 1,
                      "id": "eth"
                    }
                  }
                ]
              }
            }
          ],
          "total": 1,
          "uniqueVoters": 1
        },
        "all": {
          "total": 1,
          "uniqueVoters": 1
        },
        "lifetime": {
          "bullish": {
            "topVoters": [
              {
                "id": 1,
                "profileId": 1,
                "displayName": "text",
                "username": "text",
                "avatarUrl": "https://example.com",
                "description": "text",
                "score": 1,
                "status": "ACTIVE",
                "userkeys": [
                  "text"
                ],
                "xpTotal": 1,
                "xpStreakDays": 1,
                "xpRemovedDueToAbuse": true,
                "influenceFactor": 1,
                "influenceFactorPercentile": 1,
                "humanVerificationStatus": "REQUESTED",
                "validatorNftCount": 1,
                "links": {
                  "profile": "https://example.com",
                  "scoreBreakdown": "https://example.com"
                },
                "stats": {
                  "holdingsWei": 1,
                  "review": {
                    "received": {
                      "negative": 1,
                      "neutral": 1,
                      "positive": 1
                    }
                  },
                  "vouch": {
                    "given": {
                      "amountWeiTotal": 1,
                      "count": 1
                    },
                    "received": {
                      "amountWeiTotal": 1,
                      "count": 1
                    }
                  },
                  "vouchTotals": [
                    {
                      "balance": {
                        "given": 1,
                        "received": 1
                      },
                      "count": {
                        "given": 1,
                        "received": 1
                      },
                      "token": {
                        "address": "text",
                        "decimals": 1,
                        "id": "eth"
                      }
                    }
                  ]
                }
              }
            ],
            "total": 1
          },
          "bearish": {
            "topVoters": [
              {
                "id": 1,
                "profileId": 1,
                "displayName": "text",
                "username": "text",
                "avatarUrl": "https://example.com",
                "description": "text",
                "score": 1,
                "status": "ACTIVE",
                "userkeys": [
                  "text"
                ],
                "xpTotal": 1,
                "xpStreakDays": 1,
                "xpRemovedDueToAbuse": true,
                "influenceFactor": 1,
                "influenceFactorPercentile": 1,
                "humanVerificationStatus": "REQUESTED",
                "validatorNftCount": 1,
                "links": {
                  "profile": "https://example.com",
                  "scoreBreakdown": "https://example.com"
                },
                "stats": {
                  "holdingsWei": 1,
                  "review": {
                    "received": {
                      "negative": 1,
                      "neutral": 1,
                      "positive": 1
                    }
                  },
                  "vouch": {
                    "given": {
                      "amountWeiTotal": 1,
                      "count": 1
                    },
                    "received": {
                      "amountWeiTotal": 1,
                      "count": 1
                    }
                  },
                  "vouchTotals": [
                    {
                      "balance": {
                        "given": 1,
                        "received": 1
                      },
                      "count": {
                        "given": 1,
                        "received": 1
                      },
                      "token": {
                        "address": "text",
                        "decimals": 1,
                        "id": "eth"
                      }
                    }
                  ]
                }
              }
            ],
            "total": 1
          }
        },
        "currentPeriod": {
          "bullish": {
            "total": 1
          },
          "bearish": {
            "total": 1
          }
        }
      },
      "categories": [
        {
          "id": 1,
          "name": "text",
          "slug": "text",
          "description": "text"
        }
      ],
      "chains": [
        {
          "id": 1,
          "name": "text",
          "url": "https://example.com",
          "iconUrl": "https://example.com"
        }
      ],
      "links": [
        {
          "type": "WEBSITE",
          "url": "https://example.com"
        }
      ],
      "commentCount": 1
    }
  ],
  "total": 1
}

Get suggested listings projects. Returns mixed scope data: lifetime top voters with current period vote percentages.

get

Query parameters

limitnumberOptionalDefault: 5

scopestring · enumOptionalDefault: current-periodPossible values:

startDatestringOptional

endDatestringOptional

yearinteger · min: -9007199254740991 · max: 9007199254740991Optional

periodinteger · max: 9007199254740991Optional

Responses

200

Successful response

application/json

idnumberRequired

userkeystringRequired

statusstring · enumRequiredPossible values:

bannerImageUrlstring · uriOptional

isPromotedbooleanRequired

showArchivedbooleanRequired

descriptionstringOptional

createdAtstringRequired

updatedAtstringRequired

commentCountnumberRequired

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get/projects/suggested

GET /api/v2/projects/suggested HTTP/1.1
Host: api.ethos.network
Accept: */*

[
  {
    "id": 1,
    "userkey": "text",
    "status": "ACTIVE",
    "bannerImageUrl": "https://example.com",
    "isPromoted": true,
    "showArchived": true,
    "description": "text",
    "createdAt": "text",
    "updatedAt": "text",
    "user": {
      "id": 1,
      "profileId": 1,
      "displayName": "text",
      "username": "text",
      "avatarUrl": "https://example.com",
      "description": "text",
      "score": 1,
      "status": "ACTIVE",
      "userkeys": [
        "text"
      ],
      "xpTotal": 1,
      "xpStreakDays": 1,
      "xpRemovedDueToAbuse": true,
      "influenceFactor": 1,
      "influenceFactorPercentile": 1,
      "humanVerificationStatus": "REQUESTED",
      "validatorNftCount": 1,
      "links": {
        "profile": "https://example.com",
        "scoreBreakdown": "https://example.com"
      },
      "stats": {
        "holdingsWei": 1,
        "review": {
          "received": {
            "negative": 1,
            "neutral": 1,
            "positive": 1
          }
        },
        "vouch": {
          "given": {
            "amountWeiTotal": 1,
            "count": 1
          },
          "received": {
            "amountWeiTotal": 1,
            "count": 1
          }
        },
        "vouchTotals": [
          {
            "balance": {
              "given": 1,
              "received": 1
            },
            "count": {
              "given": 1,
              "received": 1
            },
            "token": {
              "address": "text",
              "decimals": 1,
              "id": "eth"
            }
          }
        ]
      }
    },
    "votes": {
      "bullish": {
        "topVoters": [
          {
            "id": 1,
            "profileId": 1,
            "displayName": "text",
            "username": "text",
            "avatarUrl": "https://example.com",
            "description": "text",
            "score": 1,
            "status": "ACTIVE",
            "userkeys": [
              "text"
            ],
            "xpTotal": 1,
            "xpStreakDays": 1,
            "xpRemovedDueToAbuse": true,
            "influenceFactor": 1,
            "influenceFactorPercentile": 1,
            "humanVerificationStatus": "REQUESTED",
            "validatorNftCount": 1,
            "links": {
              "profile": "https://example.com",
              "scoreBreakdown": "https://example.com"
            },
            "stats": {
              "holdingsWei": 1,
              "review": {
                "received": {
                  "negative": 1,
                  "neutral": 1,
                  "positive": 1
                }
              },
              "vouch": {
                "given": {
                  "amountWeiTotal": 1,
                  "count": 1
                },
                "received": {
                  "amountWeiTotal": 1,
                  "count": 1
                }
              },
              "vouchTotals": [
                {
                  "balance": {
                    "given": 1,
                    "received": 1
                  },
                  "count": {
                    "given": 1,
                    "received": 1
                  },
                  "token": {
                    "address": "text",
                    "decimals": 1,
                    "id": "eth"
                  }
                }
              ]
            }
          }
        ],
        "total": 1,
        "uniqueVoters": 1
      },
      "bearish": {
        "topVoters": [
          {
            "id": 1,
            "profileId": 1,
            "displayName": "text",
            "username": "text",
            "avatarUrl": "https://example.com",
            "description": "text",
            "score": 1,
            "status": "ACTIVE",
            "userkeys": [
              "text"
            ],
            "xpTotal": 1,
            "xpStreakDays": 1,
            "xpRemovedDueToAbuse": true,
            "influenceFactor": 1,
            "influenceFactorPercentile": 1,
            "humanVerificationStatus": "REQUESTED",
            "validatorNftCount": 1,
            "links": {
              "profile": "https://example.com",
              "scoreBreakdown": "https://example.com"
            },
            "stats": {
              "holdingsWei": 1,
              "review": {
                "received": {
                  "negative": 1,
                  "neutral": 1,
                  "positive": 1
                }
              },
              "vouch": {
                "given": {
                  "amountWeiTotal": 1,
                  "count": 1
                },
                "received": {
                  "amountWeiTotal": 1,
                  "count": 1
                }
              },
              "vouchTotals": [
                {
                  "balance": {
                    "given": 1,
                    "received": 1
                  },
                  "count": {
                    "given": 1,
                    "received": 1
                  },
                  "token": {
                    "address": "text",
                    "decimals": 1,
                    "id": "eth"
                  }
                }
              ]
            }
          }
        ],
        "total": 1,
        "uniqueVoters": 1
      },
      "all": {
        "total": 1,
        "uniqueVoters": 1
      },
      "lifetime": {
        "bullish": {
          "topVoters": [
            {
              "id": 1,
              "profileId": 1,
              "displayName": "text",
              "username": "text",
              "avatarUrl": "https://example.com",
              "description": "text",
              "score": 1,
              "status": "ACTIVE",
              "userkeys": [
                "text"
              ],
              "xpTotal": 1,
              "xpStreakDays": 1,
              "xpRemovedDueToAbuse": true,
              "influenceFactor": 1,
              "influenceFactorPercentile": 1,
              "humanVerificationStatus": "REQUESTED",
              "validatorNftCount": 1,
              "links": {
                "profile": "https://example.com",
                "scoreBreakdown": "https://example.com"
              },
              "stats": {
                "holdingsWei": 1,
                "review": {
                  "received": {
                    "negative": 1,
                    "neutral": 1,
                    "positive": 1
                  }
                },
                "vouch": {
                  "given": {
                    "amountWeiTotal": 1,
                    "count": 1
                  },
                  "received": {
                    "amountWeiTotal": 1,
                    "count": 1
                  }
                },
                "vouchTotals": [
                  {
                    "balance": {
                      "given": 1,
                      "received": 1
                    },
                    "count": {
                      "given": 1,
                      "received": 1
                    },
                    "token": {
                      "address": "text",
                      "decimals": 1,
                      "id": "eth"
                    }
                  }
                ]
              }
            }
          ],
          "total": 1
        },
        "bearish": {
          "topVoters": [
            {
              "id": 1,
              "profileId": 1,
              "displayName": "text",
              "username": "text",
              "avatarUrl": "https://example.com",
              "description": "text",
              "score": 1,
              "status": "ACTIVE",
              "userkeys": [
                "text"
              ],
              "xpTotal": 1,
              "xpStreakDays": 1,
              "xpRemovedDueToAbuse": true,
              "influenceFactor": 1,
              "influenceFactorPercentile": 1,
              "humanVerificationStatus": "REQUESTED",
              "validatorNftCount": 1,
              "links": {
                "profile": "https://example.com",
                "scoreBreakdown": "https://example.com"
              },
              "stats": {
                "holdingsWei": 1,
                "review": {
                  "received": {
                    "negative": 1,
                    "neutral": 1,
                    "positive": 1
                  }
                },
                "vouch": {
                  "given": {
                    "amountWeiTotal": 1,
                    "count": 1
                  },
                  "received": {
                    "amountWeiTotal": 1,
                    "count": 1
                  }
                },
                "vouchTotals": [
                  {
                    "balance": {
                      "given": 1,
                      "received": 1
                    },
                    "count": {
                      "given": 1,
                      "received": 1
                    },
                    "token": {
                      "address": "text",
                      "decimals": 1,
                      "id": "eth"
                    }
                  }
                ]
              }
            }
          ],
          "total": 1
        }
      },
      "currentPeriod": {
        "bullish": {
          "total": 1
        },
        "bearish": {
          "total": 1
        }
      }
    },
    "categories": [
      {
        "id": 1,
        "name": "text",
        "slug": "text",
        "description": "text"
      }
    ],
    "chains": [
      {
        "id": 1,
        "name": "text",
        "url": "https://example.com",
        "iconUrl": "https://example.com"
      }
    ],
    "links": [
      {
        "type": "WEBSITE",
        "url": "https://example.com"
      }
    ],
    "commentCount": 1
  }
]

Confirm project creation using a token (Admin only)

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

userkeystringRequired

timeoutnumberOptionalDefault: 30000

Responses

200

Successful response

application/json

idnumberRequired

userkeystringRequired

statusstring · enumRequiredPossible values:

bannerImageUrlstring · uriOptional

isPromotedbooleanRequired

showArchivedbooleanRequired

descriptionstringOptional

createdAtstringRequired

updatedAtstringRequired

commentCountnumberRequired

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get/projects/confirm

GET /api/v2/projects/confirm?userkey=text HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 1,
  "userkey": "text",
  "status": "ACTIVE",
  "bannerImageUrl": "https://example.com",
  "isPromoted": true,
  "showArchived": true,
  "description": "text",
  "createdAt": "text",
  "updatedAt": "text",
  "user": {
    "id": 1,
    "profileId": 1,
    "displayName": "text",
    "username": "text",
    "avatarUrl": "https://example.com",
    "description": "text",
    "score": 1,
    "status": "ACTIVE",
    "userkeys": [
      "text"
    ],
    "xpTotal": 1,
    "xpStreakDays": 1,
    "xpRemovedDueToAbuse": true,
    "influenceFactor": 1,
    "influenceFactorPercentile": 1,
    "humanVerificationStatus": "REQUESTED",
    "validatorNftCount": 1,
    "links": {
      "profile": "https://example.com",
      "scoreBreakdown": "https://example.com"
    },
    "stats": {
      "holdingsWei": 1,
      "review": {
        "received": {
          "negative": 1,
          "neutral": 1,
          "positive": 1
        }
      },
      "vouch": {
        "given": {
          "amountWeiTotal": 1,
          "count": 1
        },
        "received": {
          "amountWeiTotal": 1,
          "count": 1
        }
      },
      "vouchTotals": [
        {
          "balance": {
            "given": 1,
            "received": 1
          },
          "count": {
            "given": 1,
            "received": 1
          },
          "token": {
            "address": "text",
            "decimals": 1,
            "id": "eth"
          }
        }
      ]
    }
  },
  "votes": {
    "bullish": {
      "topVoters": [
        {
          "id": 1,
          "profileId": 1,
          "displayName": "text",
          "username": "text",
          "avatarUrl": "https://example.com",
          "description": "text",
          "score": 1,
          "status": "ACTIVE",
          "userkeys": [
            "text"
          ],
          "xpTotal": 1,
          "xpStreakDays": 1,
          "xpRemovedDueToAbuse": true,
          "influenceFactor": 1,
          "influenceFactorPercentile": 1,
          "humanVerificationStatus": "REQUESTED",
          "validatorNftCount": 1,
          "links": {
            "profile": "https://example.com",
            "scoreBreakdown": "https://example.com"
          },
          "stats": {
            "holdingsWei": 1,
            "review": {
              "received": {
                "negative": 1,
                "neutral": 1,
                "positive": 1
              }
            },
            "vouch": {
              "given": {
                "amountWeiTotal": 1,
                "count": 1
              },
              "received": {
                "amountWeiTotal": 1,
                "count": 1
              }
            },
            "vouchTotals": [
              {
                "balance": {
                  "given": 1,
                  "received": 1
                },
                "count": {
                  "given": 1,
                  "received": 1
                },
                "token": {
                  "address": "text",
                  "decimals": 1,
                  "id": "eth"
                }
              }
            ]
          }
        }
      ],
      "total": 1,
      "uniqueVoters": 1
    },
    "bearish": {
      "topVoters": [
        {
          "id": 1,
          "profileId": 1,
          "displayName": "text",
          "username": "text",
          "avatarUrl": "https://example.com",
          "description": "text",
          "score": 1,
          "status": "ACTIVE",
          "userkeys": [
            "text"
          ],
          "xpTotal": 1,
          "xpStreakDays": 1,
          "xpRemovedDueToAbuse": true,
          "influenceFactor": 1,
          "influenceFactorPercentile": 1,
          "humanVerificationStatus": "REQUESTED",
          "validatorNftCount": 1,
          "links": {
            "profile": "https://example.com",
            "scoreBreakdown": "https://example.com"
          },
          "stats": {
            "holdingsWei": 1,
            "review": {
              "received": {
                "negative": 1,
                "neutral": 1,
                "positive": 1
              }
            },
            "vouch": {
              "given": {
                "amountWeiTotal": 1,
                "count": 1
              },
              "received": {
                "amountWeiTotal": 1,
                "count": 1
              }
            },
            "vouchTotals": [
              {
                "balance": {
                  "given": 1,
                  "received": 1
                },
                "count": {
                  "given": 1,
                  "received": 1
                },
                "token": {
                  "address": "text",
                  "decimals": 1,
                  "id": "eth"
                }
              }
            ]
          }
        }
      ],
      "total": 1,
      "uniqueVoters": 1
    },
    "all": {
      "total": 1,
      "uniqueVoters": 1
    },
    "lifetime": {
      "bullish": {
        "topVoters": [
          {
            "id": 1,
            "profileId": 1,
            "displayName": "text",
            "username": "text",
            "avatarUrl": "https://example.com",
            "description": "text",
            "score": 1,
            "status": "ACTIVE",
            "userkeys": [
              "text"
            ],
            "xpTotal": 1,
            "xpStreakDays": 1,
            "xpRemovedDueToAbuse": true,
            "influenceFactor": 1,
            "influenceFactorPercentile": 1,
            "humanVerificationStatus": "REQUESTED",
            "validatorNftCount": 1,
            "links": {
              "profile": "https://example.com",
              "scoreBreakdown": "https://example.com"
            },
            "stats": {
              "holdingsWei": 1,
              "review": {
                "received": {
                  "negative": 1,
                  "neutral": 1,
                  "positive": 1
                }
              },
              "vouch": {
                "given": {
                  "amountWeiTotal": 1,
                  "count": 1
                },
                "received": {
                  "amountWeiTotal": 1,
                  "count": 1
                }
              },
              "vouchTotals": [
                {
                  "balance": {
                    "given": 1,
                    "received": 1
                  },
                  "count": {
                    "given": 1,
                    "received": 1
                  },
                  "token": {
                    "address": "text",
                    "decimals": 1,
                    "id": "eth"
                  }
                }
              ]
            }
          }
        ],
        "total": 1
      },
      "bearish": {
        "topVoters": [
          {
            "id": 1,
            "profileId": 1,
            "displayName": "text",
            "username": "text",
            "avatarUrl": "https://example.com",
            "description": "text",
            "score": 1,
            "status": "ACTIVE",
            "userkeys": [
              "text"
            ],
            "xpTotal": 1,
            "xpStreakDays": 1,
            "xpRemovedDueToAbuse": true,
            "influenceFactor": 1,
            "influenceFactorPercentile": 1,
            "humanVerificationStatus": "REQUESTED",
            "validatorNftCount": 1,
            "links": {
              "profile": "https://example.com",
              "scoreBreakdown": "https://example.com"
            },
            "stats": {
              "holdingsWei": 1,
              "review": {
                "received": {
                  "negative": 1,
                  "neutral": 1,
                  "positive": 1
                }
              },
              "vouch": {
                "given": {
                  "amountWeiTotal": 1,
                  "count": 1
                },
                "received": {
                  "amountWeiTotal": 1,
                  "count": 1
                }
              },
              "vouchTotals": [
                {
                  "balance": {
                    "given": 1,
                    "received": 1
                  },
                  "count": {
                    "given": 1,
                    "received": 1
                  },
                  "token": {
                    "address": "text",
                    "decimals": 1,
                    "id": "eth"
                  }
                }
              ]
            }
          }
        ],
        "total": 1
      }
    },
    "currentPeriod": {
      "bullish": {
        "total": 1
      },
      "bearish": {
        "total": 1
      }
    }
  },
  "categories": [
    {
      "id": 1,
      "name": "text",
      "slug": "text",
      "description": "text"
    }
  ],
  "chains": [
    {
      "id": 1,
      "name": "text",
      "url": "https://example.com",
      "iconUrl": "https://example.com"
    }
  ],
  "links": [
    {
      "type": "WEBSITE",
      "url": "https://example.com"
    }
  ],
  "commentCount": 1
}

Get a specific listing project by ID

get

Path parameters

projectIdinteger · max: 2147483647Required

Responses

200

Successful response

application/json

idnumberRequired

userkeystringRequired

statusstring · enumRequiredPossible values:

bannerImageUrlstring · uriOptional

isPromotedbooleanRequired

showArchivedbooleanRequired

descriptionstringOptional

createdAtstringRequired

updatedAtstringRequired

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get/projects/{projectId}

GET /api/v2/projects/{projectId} HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "id": 1,
  "userkey": "text",
  "status": "ACTIVE",
  "bannerImageUrl": "https://example.com",
  "isPromoted": true,
  "showArchived": true,
  "description": "text",
  "createdAt": "text",
  "updatedAt": "text"
}

Update an existing project (Admin or Project Owner only)

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

projectIdinteger · max: 2147483647Required

Body

descriptionstringOptional

bannerImageUrlstring · uri · nullableOptional

categoryIdsinteger[]Optional

chainsinteger[]Optional

isPromotedbooleanOptional

showArchivedbooleanOptional

launchDatestringOptional

statusstring · enumOptionalPossible values:

Responses

200

Successful response

application/json

idnumberRequired

userkeystringRequired

statusstring · enumRequiredPossible values:

bannerImageUrlstring · uriOptional

isPromotedbooleanRequired

showArchivedbooleanRequired

descriptionstringOptional

createdAtstringRequired

updatedAtstringRequired

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

put/projects/{projectId}

PUT /api/v2/projects/{projectId} HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 225

{
  "description": "text",
  "bannerImageUrl": "https://example.com",
  "categoryIds": [
    1
  ],
  "chains": [
    1
  ],
  "isPromoted": true,
  "showArchived": true,
  "launchDate": "text",
  "links": [
    {
      "type": "WEBSITE",
      "url": "https://example.com"
    }
  ],
  "status": "ACTIVE"
}

{
  "id": 1,
  "userkey": "text",
  "status": "ACTIVE",
  "bannerImageUrl": "https://example.com",
  "isPromoted": true,
  "showArchived": true,
  "description": "text",
  "createdAt": "text",
  "updatedAt": "text"
}

Get detailed information for a specific project, showing votes for current season

get

Path parameters

projectIdinteger · max: 2147483647Required

Query parameters

topVotersLimitnumber · max: 100OptionalDefault: 3

yearnumberOptional

periodnumberOptional

Responses

200

Successful response

application/json

idnumberRequired

userkeystringRequired

statusstring · enumRequiredPossible values:

bannerImageUrlstring · uriOptional

isPromotedbooleanRequired

showArchivedbooleanRequired

descriptionstringOptional

createdAtstringRequired

updatedAtstringRequired

commentCountnumberRequired

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get/projects/{projectId}/details

GET /api/v2/projects/{projectId}/details HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "id": 1,
  "userkey": "text",
  "status": "ACTIVE",
  "bannerImageUrl": "https://example.com",
  "isPromoted": true,
  "showArchived": true,
  "description": "text",
  "createdAt": "text",
  "updatedAt": "text",
  "user": {
    "id": 1,
    "profileId": 1,
    "displayName": "text",
    "username": "text",
    "avatarUrl": "https://example.com",
    "description": "text",
    "score": 1,
    "status": "ACTIVE",
    "userkeys": [
      "text"
    ],
    "xpTotal": 1,
    "xpStreakDays": 1,
    "xpRemovedDueToAbuse": true,
    "influenceFactor": 1,
    "influenceFactorPercentile": 1,
    "humanVerificationStatus": "REQUESTED",
    "validatorNftCount": 1,
    "links": {
      "profile": "https://example.com",
      "scoreBreakdown": "https://example.com"
    },
    "stats": {
      "holdingsWei": 1,
      "review": {
        "received": {
          "negative": 1,
          "neutral": 1,
          "positive": 1
        }
      },
      "vouch": {
        "given": {
          "amountWeiTotal": 1,
          "count": 1
        },
        "received": {
          "amountWeiTotal": 1,
          "count": 1
        }
      },
      "vouchTotals": [
        {
          "balance": {
            "given": 1,
            "received": 1
          },
          "count": {
            "given": 1,
            "received": 1
          },
          "token": {
            "address": "text",
            "decimals": 1,
            "id": "eth"
          }
        }
      ]
    }
  },
  "votes": {
    "bullish": {
      "topVoters": [
        {
          "id": 1,
          "profileId": 1,
          "displayName": "text",
          "username": "text",
          "avatarUrl": "https://example.com",
          "description": "text",
          "score": 1,
          "status": "ACTIVE",
          "userkeys": [
            "text"
          ],
          "xpTotal": 1,
          "xpStreakDays": 1,
          "xpRemovedDueToAbuse": true,
          "influenceFactor": 1,
          "influenceFactorPercentile": 1,
          "humanVerificationStatus": "REQUESTED",
          "validatorNftCount": 1,
          "links": {
            "profile": "https://example.com",
            "scoreBreakdown": "https://example.com"
          },
          "stats": {
            "holdingsWei": 1,
            "review": {
              "received": {
                "negative": 1,
                "neutral": 1,
                "positive": 1
              }
            },
            "vouch": {
              "given": {
                "amountWeiTotal": 1,
                "count": 1
              },
              "received": {
                "amountWeiTotal": 1,
                "count": 1
              }
            },
            "vouchTotals": [
              {
                "balance": {
                  "given": 1,
                  "received": 1
                },
                "count": {
                  "given": 1,
                  "received": 1
                },
                "token": {
                  "address": "text",
                  "decimals": 1,
                  "id": "eth"
                }
              }
            ]
          }
        }
      ],
      "total": 1,
      "uniqueVoters": 1
    },
    "bearish": {
      "topVoters": [
        {
          "id": 1,
          "profileId": 1,
          "displayName": "text",
          "username": "text",
          "avatarUrl": "https://example.com",
          "description": "text",
          "score": 1,
          "status": "ACTIVE",
          "userkeys": [
            "text"
          ],
          "xpTotal": 1,
          "xpStreakDays": 1,
          "xpRemovedDueToAbuse": true,
          "influenceFactor": 1,
          "influenceFactorPercentile": 1,
          "humanVerificationStatus": "REQUESTED",
          "validatorNftCount": 1,
          "links": {
            "profile": "https://example.com",
            "scoreBreakdown": "https://example.com"
          },
          "stats": {
            "holdingsWei": 1,
            "review": {
              "received": {
                "negative": 1,
                "neutral": 1,
                "positive": 1
              }
            },
            "vouch": {
              "given": {
                "amountWeiTotal": 1,
                "count": 1
              },
              "received": {
                "amountWeiTotal": 1,
                "count": 1
              }
            },
            "vouchTotals": [
              {
                "balance": {
                  "given": 1,
                  "received": 1
                },
                "count": {
                  "given": 1,
                  "received": 1
                },
                "token": {
                  "address": "text",
                  "decimals": 1,
                  "id": "eth"
                }
              }
            ]
          }
        }
      ],
      "total": 1,
      "uniqueVoters": 1
    },
    "all": {
      "total": 1,
      "uniqueVoters": 1
    },
    "lifetime": {
      "bullish": {
        "topVoters": [
          {
            "id": 1,
            "profileId": 1,
            "displayName": "text",
            "username": "text",
            "avatarUrl": "https://example.com",
            "description": "text",
            "score": 1,
            "status": "ACTIVE",
            "userkeys": [
              "text"
            ],
            "xpTotal": 1,
            "xpStreakDays": 1,
            "xpRemovedDueToAbuse": true,
            "influenceFactor": 1,
            "influenceFactorPercentile": 1,
            "humanVerificationStatus": "REQUESTED",
            "validatorNftCount": 1,
            "links": {
              "profile": "https://example.com",
              "scoreBreakdown": "https://example.com"
            },
            "stats": {
              "holdingsWei": 1,
              "review": {
                "received": {
                  "negative": 1,
                  "neutral": 1,
                  "positive": 1
                }
              },
              "vouch": {
                "given": {
                  "amountWeiTotal": 1,
                  "count": 1
                },
                "received": {
                  "amountWeiTotal": 1,
                  "count": 1
                }
              },
              "vouchTotals": [
                {
                  "balance": {
                    "given": 1,
                    "received": 1
                  },
                  "count": {
                    "given": 1,
                    "received": 1
                  },
                  "token": {
                    "address": "text",
                    "decimals": 1,
                    "id": "eth"
                  }
                }
              ]
            }
          }
        ],
        "total": 1
      },
      "bearish": {
        "topVoters": [
          {
            "id": 1,
            "profileId": 1,
            "displayName": "text",
            "username": "text",
            "avatarUrl": "https://example.com",
            "description": "text",
            "score": 1,
            "status": "ACTIVE",
            "userkeys": [
              "text"
            ],
            "xpTotal": 1,
            "xpStreakDays": 1,
            "xpRemovedDueToAbuse": true,
            "influenceFactor": 1,
            "influenceFactorPercentile": 1,
            "humanVerificationStatus": "REQUESTED",
            "validatorNftCount": 1,
            "links": {
              "profile": "https://example.com",
              "scoreBreakdown": "https://example.com"
            },
            "stats": {
              "holdingsWei": 1,
              "review": {
                "received": {
                  "negative": 1,
                  "neutral": 1,
                  "positive": 1
                }
              },
              "vouch": {
                "given": {
                  "amountWeiTotal": 1,
                  "count": 1
                },
                "received": {
                  "amountWeiTotal": 1,
                  "count": 1
                }
              },
              "vouchTotals": [
                {
                  "balance": {
                    "given": 1,
                    "received": 1
                  },
                  "count": {
                    "given": 1,
                    "received": 1
                  },
                  "token": {
                    "address": "text",
                    "decimals": 1,
                    "id": "eth"
                  }
                }
              ]
            }
          }
        ],
        "total": 1
      }
    },
    "currentPeriod": {
      "bullish": {
        "total": 1
      },
      "bearish": {
        "total": 1
      }
    }
  },
  "categories": [
    {
      "id": 1,
      "name": "text",
      "slug": "text",
      "description": "text"
    }
  ],
  "chains": [
    {
      "id": 1,
      "name": "text",
      "url": "https://example.com",
      "iconUrl": "https://example.com"
    }
  ],
  "links": [
    {
      "type": "WEBSITE",
      "url": "https://example.com"
    }
  ],
  "commentCount": 1
}

Get detailed information for a specific project by username, showing votes for current season

get

Path parameters

usernamestringRequired

Query parameters

topVotersLimitnumberOptionalDefault: 3

yearnumberOptional

periodnumberOptional

Responses

200

Successful response

application/json

idnumberRequired

userkeystringRequired

statusstring · enumRequiredPossible values:

bannerImageUrlstring · uriOptional

isPromotedbooleanRequired

showArchivedbooleanRequired

descriptionstringOptional

createdAtstringRequired

updatedAtstringRequired

commentCountnumberRequired

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get/projects/username/{username}

GET /api/v2/projects/username/{username} HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "id": 1,
  "userkey": "text",
  "status": "ACTIVE",
  "bannerImageUrl": "https://example.com",
  "isPromoted": true,
  "showArchived": true,
  "description": "text",
  "createdAt": "text",
  "updatedAt": "text",
  "user": {
    "id": 1,
    "profileId": 1,
    "displayName": "text",
    "username": "text",
    "avatarUrl": "https://example.com",
    "description": "text",
    "score": 1,
    "status": "ACTIVE",
    "userkeys": [
      "text"
    ],
    "xpTotal": 1,
    "xpStreakDays": 1,
    "xpRemovedDueToAbuse": true,
    "influenceFactor": 1,
    "influenceFactorPercentile": 1,
    "humanVerificationStatus": "REQUESTED",
    "validatorNftCount": 1,
    "links": {
      "profile": "https://example.com",
      "scoreBreakdown": "https://example.com"
    },
    "stats": {
      "holdingsWei": 1,
      "review": {
        "received": {
          "negative": 1,
          "neutral": 1,
          "positive": 1
        }
      },
      "vouch": {
        "given": {
          "amountWeiTotal": 1,
          "count": 1
        },
        "received": {
          "amountWeiTotal": 1,
          "count": 1
        }
      },
      "vouchTotals": [
        {
          "balance": {
            "given": 1,
            "received": 1
          },
          "count": {
            "given": 1,
            "received": 1
          },
          "token": {
            "address": "text",
            "decimals": 1,
            "id": "eth"
          }
        }
      ]
    }
  },
  "votes": {
    "bullish": {
      "topVoters": [
        {
          "id": 1,
          "profileId": 1,
          "displayName": "text",
          "username": "text",
          "avatarUrl": "https://example.com",
          "description": "text",
          "score": 1,
          "status": "ACTIVE",
          "userkeys": [
            "text"
          ],
          "xpTotal": 1,
          "xpStreakDays": 1,
          "xpRemovedDueToAbuse": true,
          "influenceFactor": 1,
          "influenceFactorPercentile": 1,
          "humanVerificationStatus": "REQUESTED",
          "validatorNftCount": 1,
          "links": {
            "profile": "https://example.com",
            "scoreBreakdown": "https://example.com"
          },
          "stats": {
            "holdingsWei": 1,
            "review": {
              "received": {
                "negative": 1,
                "neutral": 1,
                "positive": 1
              }
            },
            "vouch": {
              "given": {
                "amountWeiTotal": 1,
                "count": 1
              },
              "received": {
                "amountWeiTotal": 1,
                "count": 1
              }
            },
            "vouchTotals": [
              {
                "balance": {
                  "given": 1,
                  "received": 1
                },
                "count": {
                  "given": 1,
                  "received": 1
                },
                "token": {
                  "address": "text",
                  "decimals": 1,
                  "id": "eth"
                }
              }
            ]
          }
        }
      ],
      "total": 1,
      "uniqueVoters": 1
    },
    "bearish": {
      "topVoters": [
        {
          "id": 1,
          "profileId": 1,
          "displayName": "text",
          "username": "text",
          "avatarUrl": "https://example.com",
          "description": "text",
          "score": 1,
          "status": "ACTIVE",
          "userkeys": [
            "text"
          ],
          "xpTotal": 1,
          "xpStreakDays": 1,
          "xpRemovedDueToAbuse": true,
          "influenceFactor": 1,
          "influenceFactorPercentile": 1,
          "humanVerificationStatus": "REQUESTED",
          "validatorNftCount": 1,
          "links": {
            "profile": "https://example.com",
            "scoreBreakdown": "https://example.com"
          },
          "stats": {
            "holdingsWei": 1,
            "review": {
              "received": {
                "negative": 1,
                "neutral": 1,
                "positive": 1
              }
            },
            "vouch": {
              "given": {
                "amountWeiTotal": 1,
                "count": 1
              },
              "received": {
                "amountWeiTotal": 1,
                "count": 1
              }
            },
            "vouchTotals": [
              {
                "balance": {
                  "given": 1,
                  "received": 1
                },
                "count": {
                  "given": 1,
                  "received": 1
                },
                "token": {
                  "address": "text",
                  "decimals": 1,
                  "id": "eth"
                }
              }
            ]
          }
        }
      ],
      "total": 1,
      "uniqueVoters": 1
    },
    "all": {
      "total": 1,
      "uniqueVoters": 1
    },
    "lifetime": {
      "bullish": {
        "topVoters": [
          {
            "id": 1,
            "profileId": 1,
            "displayName": "text",
            "username": "text",
            "avatarUrl": "https://example.com",
            "description": "text",
            "score": 1,
            "status": "ACTIVE",
            "userkeys": [
              "text"
            ],
            "xpTotal": 1,
            "xpStreakDays": 1,
            "xpRemovedDueToAbuse": true,
            "influenceFactor": 1,
            "influenceFactorPercentile": 1,
            "humanVerificationStatus": "REQUESTED",
            "validatorNftCount": 1,
            "links": {
              "profile": "https://example.com",
              "scoreBreakdown": "https://example.com"
            },
            "stats": {
              "holdingsWei": 1,
              "review": {
                "received": {
                  "negative": 1,
                  "neutral": 1,
                  "positive": 1
                }
              },
              "vouch": {
                "given": {
                  "amountWeiTotal": 1,
                  "count": 1
                },
                "received": {
                  "amountWeiTotal": 1,
                  "count": 1
                }
              },
              "vouchTotals": [
                {
                  "balance": {
                    "given": 1,
                    "received": 1
                  },
                  "count": {
                    "given": 1,
                    "received": 1
                  },
                  "token": {
                    "address": "text",
                    "decimals": 1,
                    "id": "eth"
                  }
                }
              ]
            }
          }
        ],
        "total": 1
      },
      "bearish": {
        "topVoters": [
          {
            "id": 1,
            "profileId": 1,
            "displayName": "text",
            "username": "text",
            "avatarUrl": "https://example.com",
            "description": "text",
            "score": 1,
            "status": "ACTIVE",
            "userkeys": [
              "text"
            ],
            "xpTotal": 1,
            "xpStreakDays": 1,
            "xpRemovedDueToAbuse": true,
            "influenceFactor": 1,
            "influenceFactorPercentile": 1,
            "humanVerificationStatus": "REQUESTED",
            "validatorNftCount": 1,
            "links": {
              "profile": "https://example.com",
              "scoreBreakdown": "https://example.com"
            },
            "stats": {
              "holdingsWei": 1,
              "review": {
                "received": {
                  "negative": 1,
                  "neutral": 1,
                  "positive": 1
                }
              },
              "vouch": {
                "given": {
                  "amountWeiTotal": 1,
                  "count": 1
                },
                "received": {
                  "amountWeiTotal": 1,
                  "count": 1
                }
              },
              "vouchTotals": [
                {
                  "balance": {
                    "given": 1,
                    "received": 1
                  },
                  "count": {
                    "given": 1,
                    "received": 1
                  },
                  "token": {
                    "address": "text",
                    "decimals": 1,
                    "id": "eth"
                  }
                }
              ]
            }
          }
        ],
        "total": 1
      }
    },
    "currentPeriod": {
      "bullish": {
        "total": 1
      },
      "bearish": {
        "total": 1
      }
    }
  },
  "categories": [
    {
      "id": 1,
      "name": "text",
      "slug": "text",
      "description": "text"
    }
  ],
  "chains": [
    {
      "id": 1,
      "name": "text",
      "url": "https://example.com",
      "iconUrl": "https://example.com"
    }
  ],
  "links": [
    {
      "type": "WEBSITE",
      "url": "https://example.com"
    }
  ],
  "commentCount": 1
}

Show team members for a listings project

get

Path parameters

projectIdinteger · max: 2147483647Required

Query parameters

limitinteger · max: 50OptionalDefault: 50

offsetinteger · max: 2147483647OptionalDefault: 0

Responses

200

Successful response

application/json

idnumberRequired

profileIdnumber · nullableRequired

displayNamestringRequired

usernamestring · nullableRequired

avatarUrlstring · uriRequired

descriptionstring · nullableRequired

scorenumberRequired

statusstring · enumRequiredPossible values:

userkeysstring[]Required

xpTotalnumberRequired

xpStreakDaysnumberRequired

xpRemovedDueToAbusebooleanRequired

influenceFactornumberRequired

influenceFactorPercentilenumberRequired

humanVerificationStatusstring · enum · nullableOptionalPossible values:

validatorNftCountnumberRequired

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get/projects/{projectId}/team

GET /api/v2/projects/{projectId}/team HTTP/1.1
Host: api.ethos.network
Accept: */*

[
  {
    "id": 1,
    "profileId": 1,
    "displayName": "text",
    "username": "text",
    "avatarUrl": "https://example.com",
    "description": "text",
    "score": 1,
    "status": "ACTIVE",
    "userkeys": [
      "text"
    ],
    "xpTotal": 1,
    "xpStreakDays": 1,
    "xpRemovedDueToAbuse": true,
    "influenceFactor": 1,
    "influenceFactorPercentile": 1,
    "humanVerificationStatus": "REQUESTED",
    "validatorNftCount": 1,
    "links": {
      "profile": "https://example.com",
      "scoreBreakdown": "https://example.com"
    },
    "stats": {
      "holdingsWei": 1,
      "review": {
        "received": {
          "negative": 1,
          "neutral": 1,
          "positive": 1
        }
      },
      "vouch": {
        "given": {
          "amountWeiTotal": 1,
          "count": 1
        },
        "received": {
          "amountWeiTotal": 1,
          "count": 1
        }
      },
      "vouchTotals": [
        {
          "balance": {
            "given": 1,
            "received": 1
          },
          "count": {
            "given": 1,
            "received": 1
          },
          "token": {
            "address": "text",
            "decimals": 1,
            "id": "eth"
          }
        }
      ]
    }
  }
]

Add team members to a project (Admin or Project Owner only)

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

projectIdinteger · max: 2147483647Required

Body

userIdsinteger[]Required

Responses

200

Successful response

application/json

anyOptional

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post/projects/{projectId}/team

POST /api/v2/projects/{projectId}/team HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "userIds": [
    1
  ]
}

No content

Remove a team member from a project (Admin or Project Owner only)

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

projectIdinteger · max: 2147483647Required

Query parameters

userIdsinteger[]Required

Responses

200

Successful response

application/json

anyOptional

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

delete/projects/{projectId}/team

DELETE /api/v2/projects/{projectId}/team?userIds=1 HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Add a chain to a project (Admin or Project Owner only)

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

projectIdnumberRequired

Body

chainIdnumberRequired

Responses

200

Successful response

application/json

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post/projects/{projectId}/chains

POST /api/v2/projects/{projectId}/chains HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "chainId": 1
}

{
  "chains": [
    {
      "id": 1,
      "name": "text",
      "url": "https://example.com",
      "iconUrl": "https://example.com"
    }
  ]
}

Remove a chain from a project (Admin or Project Owner only)

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

projectIdnumberRequired

chainIdnumberRequired

Responses

200

Successful response

application/json

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

delete/projects/{projectId}/chains/{chainId}

DELETE /api/v2/projects/{projectId}/chains/{chainId} HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "chains": [
    {
      "id": 1,
      "name": "text",
      "url": "https://example.com",
      "iconUrl": "https://example.com"
    }
  ]
}