Activities

Get activity by id

get
Path parameters
activityTypestring · enumRequiredPossible values:
idintegerRequired
Responses
200

Successful response

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

No content

Get activities by type and id

post
Body
activityTypestring · enumRequiredPossible values:
idintegerRequired
Responses
200

Successful response

application/json
post
/activities/bulk
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
Responseany
get
/activities/{activityType}/tx/{txHash}
GET /api/v2/activities/{activityType}/tx/{txHash} HTTP/1.1
Host: api.ethos.network
Accept: */*

No content

Get activities by userkey (author or subject)

get
Query parameters
userkeystringRequired
directionstring · enumOptionalPossible values:
orderBystring · enumOptionalPossible values:
sortstring · enumOptionalDefault: descPossible values:
reviewScorestring · enumOptionalPossible values:
includeArchivedbooleanOptional
excludeSpambooleanOptional
limitinteger · max: 1000OptionalDefault: 50
offsetnumberOptionalDefault: 0
Responses
200

Successful response

application/json
get
/activities/userkey
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
cachebooleanOptionalDefault: false
dayRangeinteger | nullableOptionalDefault: null
excludeSpambooleanOptional
limitinteger · max: 1000OptionalDefault: 50
offsetnumberOptionalDefault: 0
Responses
200

Successful response

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

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

Get activities for notifications feed

post
Authorizations
Body
excludeHistoricalbooleanOptional
excludeSpambooleanOptional
Responses
200

Successful response

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

{
  "filter": [
    "attestation"
  ],
  "excludeHistorical": true,
  "excludeSpam": true,
  "pagination": {
    "limit": 50,
    "offset": 0
  },
  "orderBy": {
    "field": "timestamp",
    "direction": "asc"
  }
}
{
  "values": [],
  "total": 1,
  "limit": 1,
  "offset": 1,
  "offsets": {
    "attestation": 1,
    "broker-post": 1,
    "closed-slash": 1,
    "invitation-accepted": 1,
    "market": 1,
    "market-vote": 1,
    "open-slash": 1,
    "project": 1,
    "reply": 1,
    "review": 1,
    "slash": 1,
    "unvouch": 1,
    "vouch": 1,
    "vote": 1
  },
  "counts": {
    "attestation": 1,
    "broker-post": 1,
    "closed-slash": 1,
    "invitation-accepted": 1,
    "market": 1,
    "market-vote": 1,
    "open-slash": 1,
    "project": 1,
    "reply": 1,
    "review": 1,
    "slash": 1,
    "unvouch": 1,
    "vouch": 1,
    "vote": 1
  }
}

Get activities authored by the specified user

post
Body
userkeystringRequired
excludeHistoricalbooleanOptional
excludeSpambooleanOptional
reviewScorestring · enumOptionalPossible values:
limitinteger · max: 1000OptionalDefault: 50
offsetnumberOptionalDefault: 0
Responses
200

Successful response

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

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

Get activities where the specified user is the subject

post
Body
userkeystringRequired
excludeHistoricalbooleanOptional
excludeSpambooleanOptional
reviewScorestring · enumOptionalPossible values:
limitinteger · max: 1000OptionalDefault: 50
offsetnumberOptionalDefault: 0
Responses
200

Successful response

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

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

Get all activities (authored & received) for a user

post
Body
userkeystringRequired
excludeHistoricalbooleanOptional
excludeSpambooleanOptional
reviewScorestring · enumOptionalPossible values:
limitinteger · max: 1000OptionalDefault: 50
offsetnumberOptionalDefault: 0
Responses
200

Successful response

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

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

Get project-related activities by project

post
Body
userkeystringRequired
excludeHistoricalbooleanOptional
excludeSpambooleanOptional
reviewScorestring · enumOptionalPossible values:
limitinteger · max: 1000OptionalDefault: 50
offsetnumberOptionalDefault: 0
Responses
200

Successful response

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

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

Get paginated list of supporters impacted by a slash

get
Path parameters
slashIdintegerRequired
Query parameters
limitinteger · max: 50OptionalDefault: 50
offsetnumberOptionalDefault: 0
Responses
200

Successful response

application/json
get
/activities/slash/{slashId}/impacted-supporters
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,
      "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
}
PreviousAPI v2NextAi Images

Last updated