Activities

Get activity by id

get

Path parameters

activityTypestring · enumRequiredPossible values:

idinteger · max: 2147483647Required

Responses

200

Successful response

application/json

objectOptional

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/activities/{activityType}/{id}

HTTPcURLJavaScriptPython

GET /api/v2/activities/{activityType}/{id} HTTP/1.1
Host: api.ethos.network
Accept: */*

{}

Get activities by type and id

post

Body

application/json

activityTypestring · enumRequiredPossible values:

idinteger · max: 2147483647Required

Responses

200

Successful response

application/json

object[]Optional

400

Invalid input data

application/json

500

Internal server error

application/json

post

/activities/bulk

HTTPcURLJavaScriptPython

POST /api/v2/activities/bulk HTTP/1.1
Host: api.ethos.network
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "activityType": "attestation",
  "id": 1
}

[
  {}
]

Get activity by transaction hash

get

Path parameters

activityTypestring · enumRequiredPossible values:

txHashstringRequiredPattern: ^0x[a-fA-F0-9]{64}$

Responses

200

Successful response

application/json

objectOptional

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/activities/{activityType}/tx/{txHash}

HTTPcURLJavaScriptPython

GET /api/v2/activities/{activityType}/tx/{txHash} HTTP/1.1
Host: api.ethos.network
Accept: */*

{}

Deprecated

[Deprecated] Get activities by userkey (author or subject). Use /activities/profile/{given,received,all} instead.

get

Query parameters

userkeystringRequired

directionstring · enumOptionalPossible values:

orderBystring · enumOptionalPossible values:

sortstring · enumOptionalDefault: descPossible values:

reviewScoreany ofOptional

string · enumOptionalPossible values:

or

includeArchivedbooleanOptional

excludeSpambooleanOptional

excludeBoostedReviewsbooleanOptional

limitinteger · min: -9007199254740991 · max: 1000OptionalDefault: 50

offsetnumberOptionalDefault: 0

Responses

200

Successful response

application/json

object[]Optional

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/activities/userkey

HTTPcURLJavaScriptPython

GET /api/v2/activities/userkey?userkey=text&activityType=PROFILE HTTP/1.1
Host: api.ethos.network
Accept: */*

[
  {}
]

Get activities optimized for the feed

post

Body

application/json

cachebooleanOptionalDefault: false

dayRangeany ofOptionalDefault: null

integer · min: 1 · max: 90Optional

or

nullOptional

excludeSpambooleanOptional

excludeUnverifiedbooleanOptional

limitinteger · min: -9007199254740991 · max: 1000OptionalDefault: 50

offsetnumberOptionalDefault: 0

Responses

200

Successful response

application/json

valuesobject[]Required

totalnumberRequired

limitnumberRequired

offsetnumberRequired

400

Invalid input data

application/json

500

Internal server error

application/json

post

/activities/feed

HTTPcURLJavaScriptPython

POST /api/v2/activities/feed HTTP/1.1
Host: api.ethos.network
Content-Type: application/json
Accept: */*
Content-Length: 169

{
  "cache": false,
  "dayRange": 1,
  "excludeSpam": true,
  "excludeUnverified": true,
  "filter": [
    "attestation"
  ],
  "orderBy": {
    "field": "timestamp",
    "direction": "asc"
  },
  "limit": 50,
  "offset": 0
}

{
  "values": [
    {}
  ],
  "total": 1,
  "limit": 1,
  "offset": 1
}

Get activities for notifications feed

post

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

excludeHistoricalbooleanOptional

excludeSpambooleanOptional

excludeUnverifiedbooleanOptional

Responses

200

Successful response

application/json

valuesobject[]Required

totalnumberRequired

limitnumberRequired

offsetnumberRequired

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/activities/notifications

HTTPcURLJavaScriptPython

POST /api/v2/activities/notifications HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 182

{
  "filter": [
    "attestation"
  ],
  "excludeHistorical": true,
  "excludeSpam": true,
  "excludeUnverified": true,
  "pagination": {
    "limit": 50,
    "offset": 0
  },
  "orderBy": {
    "field": "timestamp",
    "direction": "asc"
  }
}

{
  "values": [
    {}
  ],
  "total": 1,
  "limit": 1,
  "offset": 1,
  "offsets": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "counts": {
    "ANY_ADDITIONAL_PROPERTY": 1
  }
}

Get activities authored by the specified user

post

Body

application/json

userkeystringRequired

excludeHistoricalbooleanOptional

excludeSpambooleanOptional

excludeUnverifiedbooleanOptional

excludeBoostedReviewsbooleanOptional

reviewScoreany ofOptional

string · enumOptionalPossible values:

or

minAuthorScoreinteger · min: 1 · max: 2800Optional

limitinteger · min: -9007199254740991 · max: 1000OptionalDefault: 50

offsetnumberOptionalDefault: 0

Responses

200

Successful response

application/json

valuesobject[]Required

totalnumberRequired

limitnumberRequired

offsetnumberRequired

400

Invalid input data

application/json

500

Internal server error

application/json

post

/activities/profile/given

HTTPcURLJavaScriptPython

POST /api/v2/activities/profile/given HTTP/1.1
Host: api.ethos.network
Content-Type: application/json
Accept: */*
Content-Length: 257

{
  "userkey": "text",
  "filter": [
    "attestation"
  ],
  "excludeHistorical": true,
  "excludeSpam": true,
  "excludeUnverified": true,
  "excludeBoostedReviews": true,
  "orderBy": {
    "field": "timestamp",
    "direction": "asc"
  },
  "reviewScore": "NEGATIVE",
  "minAuthorScore": 1,
  "limit": 50,
  "offset": 0
}

{
  "values": [
    {}
  ],
  "total": 1,
  "limit": 1,
  "offset": 1
}

Get activities where the specified user is the subject

post

Body

application/json

userkeystringRequired

excludeHistoricalbooleanOptional

excludeSpambooleanOptional

excludeUnverifiedbooleanOptional

excludeBoostedReviewsbooleanOptional

reviewScoreany ofOptional

string · enumOptionalPossible values:

or

minAuthorScoreinteger · min: 1 · max: 2800Optional

limitinteger · min: -9007199254740991 · max: 1000OptionalDefault: 50

offsetnumberOptionalDefault: 0

Responses

200

Successful response

application/json

valuesobject[]Required

totalnumberRequired

limitnumberRequired

offsetnumberRequired

400

Invalid input data

application/json

500

Internal server error

application/json

post

/activities/profile/received

HTTPcURLJavaScriptPython

POST /api/v2/activities/profile/received HTTP/1.1
Host: api.ethos.network
Content-Type: application/json
Accept: */*
Content-Length: 257

{
  "userkey": "text",
  "filter": [
    "attestation"
  ],
  "excludeHistorical": true,
  "excludeSpam": true,
  "excludeUnverified": true,
  "excludeBoostedReviews": true,
  "orderBy": {
    "field": "timestamp",
    "direction": "asc"
  },
  "reviewScore": "NEGATIVE",
  "minAuthorScore": 1,
  "limit": 50,
  "offset": 0
}

{
  "values": [
    {}
  ],
  "total": 1,
  "limit": 1,
  "offset": 1
}

Get all activities (authored & received) for a user

post

Body

application/json

userkeystringRequired

excludeHistoricalbooleanOptional

excludeSpambooleanOptional

excludeUnverifiedbooleanOptional

excludeBoostedReviewsbooleanOptional

reviewScoreany ofOptional

string · enumOptionalPossible values:

or

minAuthorScoreinteger · min: 1 · max: 2800Optional

limitinteger · min: -9007199254740991 · max: 1000OptionalDefault: 50

offsetnumberOptionalDefault: 0

Responses

200

Successful response

application/json

valuesobject[]Required

totalnumberRequired

limitnumberRequired

offsetnumberRequired

400

Invalid input data

application/json

500

Internal server error

application/json

post

/activities/profile/all

HTTPcURLJavaScriptPython

POST /api/v2/activities/profile/all HTTP/1.1
Host: api.ethos.network
Content-Type: application/json
Accept: */*
Content-Length: 257

{
  "userkey": "text",
  "filter": [
    "attestation"
  ],
  "excludeHistorical": true,
  "excludeSpam": true,
  "excludeUnverified": true,
  "excludeBoostedReviews": true,
  "orderBy": {
    "field": "timestamp",
    "direction": "asc"
  },
  "reviewScore": "NEGATIVE",
  "minAuthorScore": 1,
  "limit": 50,
  "offset": 0
}

{
  "values": [
    {}
  ],
  "total": 1,
  "limit": 1,
  "offset": 1
}

Get project-related activities by project

post

Body

application/json

userkeystringRequired

excludeHistoricalbooleanOptional

excludeSpambooleanOptional

excludeUnverifiedbooleanOptional

excludeBoostedReviewsbooleanOptional

reviewScoreany ofOptional

string · enumOptionalPossible values:

or

minAuthorScoreinteger · min: 1 · max: 2800Optional

limitinteger · min: -9007199254740991 · max: 1000OptionalDefault: 50

offsetnumberOptionalDefault: 0

Responses

200

Successful response

application/json

valuesobject[]Required

totalnumberRequired

limitnumberRequired

offsetnumberRequired

400

Invalid input data

application/json

500

Internal server error

application/json

post

/activities/project

HTTPcURLJavaScriptPython

POST /api/v2/activities/project HTTP/1.1
Host: api.ethos.network
Content-Type: application/json
Accept: */*
Content-Length: 257

{
  "userkey": "text",
  "filter": [
    "attestation"
  ],
  "excludeHistorical": true,
  "excludeSpam": true,
  "excludeUnverified": true,
  "excludeBoostedReviews": true,
  "orderBy": {
    "field": "timestamp",
    "direction": "asc"
  },
  "reviewScore": "NEGATIVE",
  "minAuthorScore": 1,
  "limit": 50,
  "offset": 0
}

{
  "values": [
    {}
  ],
  "total": 1,
  "limit": 1,
  "offset": 1
}

Get paginated list of supporters impacted by a slash

get

Path parameters

slashIdinteger · max: 2147483647Required

Query parameters

limitinteger · min: -9007199254740991 · 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

/activities/slash/{slashId}/impacted-supporters

HTTPcURLJavaScriptPython

GET /api/v2/activities/slash/{slashId}/impacted-supporters 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
          }
        }
      },
      "penaltyAmount": 1
    }
  ],
  "total": 1,
  "limit": 1,
  "offset": 1
}