Activity

Get activity by id

get
Path parameters
activityTypestring · enumRequiredPossible values:
idintegerRequired
Responses
200
Successful response
application/json
Responseany
get
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
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
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:
reviewTypestring · enumOptionalPossible values:
includeArchivedbooleanOptional
limitinteger · max: 1000OptionalDefault: 50
offsetnumberOptionalDefault: 0
Responses
200
Successful response
application/json
get
GET /api/v2/activities/userkey HTTP/1.1
Host: api.ethos.network
Accept: */*

[]

Get activities optimized for the feed

post
Body
cachebooleanOptionalDefault: false
dayRangeinteger | nullableOptionalDefault: null
limitinteger · max: 1000OptionalDefault: 50
offsetnumberOptionalDefault: 0
Responses
200
Successful response
application/json
post
POST /api/v2/activities/feed HTTP/1.1
Host: api.ethos.network
Content-Type: application/json
Accept: */*
Content-Length: 125

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

Get activities for notifications feed

post
Authorizations
Body
excludeHistoricalbooleanOptional
Responses
200
Successful response
application/json
post
POST /api/v2/activities/notifications HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 138

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

Get activities authored by the specified user

post
Body
userkeystringRequired
excludeHistoricalbooleanOptional
limitinteger · max: 1000OptionalDefault: 50
offsetnumberOptionalDefault: 0
Responses
200
Successful response
application/json
post
POST /api/v2/activities/profile/given HTTP/1.1
Host: api.ethos.network
Content-Type: application/json
Accept: */*
Content-Length: 140

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

Get activities where the specified user is the subject

post
Body
userkeystringRequired
excludeHistoricalbooleanOptional
limitinteger · max: 1000OptionalDefault: 50
offsetnumberOptionalDefault: 0
Responses
200
Successful response
application/json
post
POST /api/v2/activities/profile/received HTTP/1.1
Host: api.ethos.network
Content-Type: application/json
Accept: */*
Content-Length: 140

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

Get all activities (authored & received) for a user

post
Body
userkeystringRequired
excludeHistoricalbooleanOptional
limitinteger · max: 1000OptionalDefault: 50
offsetnumberOptionalDefault: 0
Responses
200
Successful response
application/json
post
POST /api/v2/activities/profile/all HTTP/1.1
Host: api.ethos.network
Content-Type: application/json
Accept: */*
Content-Length: 140

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

Get project-related activities by project

post
Body
userkeystringRequired
excludeHistoricalbooleanOptional
limitinteger · max: 1000OptionalDefault: 50
offsetnumberOptionalDefault: 0
Responses
200
Successful response
application/json
post
POST /api/v2/activities/project HTTP/1.1
Host: api.ethos.network
Content-Type: application/json
Accept: */*
Content-Length: 140

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