Vouches

Query vouches with optional filters

post

⚠️ Warning: This is a beta endpoint. It is not guaranteed to be stable and may change or break without notice.

Body

application/json

idsnumber[]Optional

subjectUserkeysstring[]Optional

authorProfileIdsinteger[]Optional

subjectProfileIdsinteger[]Optional

subjectAddressesstring[]Optional

archivedbooleanOptional

afterDatestringOptional

durationstringOptional

limitinteger · max: 100OptionalDefault: 50

offsetnumberOptionalDefault: 0

Responses

200

Successful response

application/json

totalnumberRequired

limitnumberRequired

offsetnumberRequired

400

Invalid input data

application/json

500

Internal server error

application/json

post

/vouches

HTTPcURLJavaScriptPython

POST /api/v2/vouches HTTP/1.1
Host: api.ethos.network
Content-Type: application/json
Accept: */*
Content-Length: 282

{
  "ids": [
    1
  ],
  "subjectUserkeys": [
    "text"
  ],
  "authorProfileIds": [
    1
  ],
  "subjectProfileIds": [
    1
  ],
  "subjectAddresses": [
    "text"
  ],
  "subjectAttestationHashes": [],
  "archived": true,
  "afterDate": "text",
  "orderBy": {
    "balance": "asc",
    "vouchedAt": "asc",
    "updatedAt": "asc"
  },
  "duration": "text",
  "limit": 50,
  "offset": 0
}

{
  "values": [
    {
      "authorProfileId": 1,
      "subjectProfileId": 1,
      "authorUser": {
        "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": {
          "review": {
            "received": {
              "negative": 1,
              "neutral": 1,
              "positive": 1
            }
          },
          "vouch": {
            "given": {
              "amountWeiTotal": 1,
              "count": 1
            },
            "received": {
              "amountWeiTotal": 1,
              "count": 1
            }
          }
        }
      },
      "subjectUser": {
        "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": {
          "review": {
            "received": {
              "negative": 1,
              "neutral": 1,
              "positive": 1
            }
          },
          "vouch": {
            "given": {
              "amountWeiTotal": 1,
              "count": 1
            },
            "received": {
              "amountWeiTotal": 1,
              "count": 1
            }
          }
        }
      },
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "total": 1,
  "limit": 1,
  "offset": 1
}

Get mutual vouchers for a viewer and target profile

get

Query parameters

viewerProfileIdinteger · max: 2147483647Required

targetProfileIdinteger · max: 2147483647Required

limitinteger · max: 50OptionalDefault: 50

offsetnumberOptionalDefault: 0

Responses

200

Successful response

application/json

totalnumberRequired

limitnumberRequired

offsetnumberRequired

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/vouches/mutual-vouchers

HTTPcURLJavaScriptPython

GET /api/v2/vouches/mutual-vouchers?viewerProfileId=1&targetProfileId=1 HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "values": [
    {
      "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": {
        "review": {
          "received": {
            "negative": 1,
            "neutral": 1,
            "positive": 1
          }
        },
        "vouch": {
          "given": {
            "amountWeiTotal": 1,
            "count": 1
          },
          "received": {
            "amountWeiTotal": 1,
            "count": 1
          }
        }
      }
    }
  ],
  "total": 1,
  "limit": 1,
  "offset": 1
}

Get vouch creation fees

get

Responses

200

Successful response

application/json

entryDonationFeeBasisPointsinteger · int64Required

entryProtocolFeeBasisPointsinteger · int64Required

entryVouchersPoolFeeBasisPointsinteger · int64Required

exitFeeBasisPointsinteger · int64Required

500

Internal server error

application/json

get

/vouches/fees

HTTPcURLJavaScriptPython

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

{
  "entryDonationFeeBasisPoints": 1,
  "entryProtocolFeeBasisPoints": 1,
  "entryVouchersPoolFeeBasisPoints": 1,
  "exitFeeBasisPoints": 1
}