Score

Get users with score updates since a timestamp

get

Query parameters

afterstringRequired

untilstringOptional

limitinteger · max: 1000OptionalDefault: 50

offsetinteger · max: 2147483647OptionalDefault: 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/score/updates

HTTPcURLJavaScriptPython

GET /api/v2/score/updates?after=text HTTP/1.1
Host: api.ethos.network
Accept: */*

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

Get score by address

get

Query parameters

addressstringRequired

Ethereum address (0x-prefixed, 20 bytes)

triggerCalculationbooleanOptional

Responses

200

Successful response

application/json

scorenumber · max: 2800Optional

levelstring · enumRequiredPossible values:

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get/score/address

HTTPcURLJavaScriptPython

GET /api/v2/score/address?address=text HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "score": 1,
  "level": "untrusted"
}

Get scores by multiple addresses

post

Body

application/json

addressesstring[]Required

Ethereum address (0x-prefixed, 20 bytes)

triggerCalculationbooleanOptional

Responses

200

Successful response

application/json

400

Invalid input data

application/json

500

Internal server error

application/json

post/score/addresses

HTTPcURLJavaScriptPython

POST /api/v2/score/addresses HTTP/1.1
Host: api.ethos.network
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "addresses": [
    "text"
  ],
  "triggerCalculation": true
}

{
  "ANY_ADDITIONAL_PROPERTY": {
    "score": 1,
    "level": "untrusted"
  }
}

Get score by userId

get

Query parameters

userIdinteger · max: 2147483647Required

Responses

200

Successful response

application/json

scorenumber · max: 2800Optional

levelstring · enumRequiredPossible values:

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get/score/userId

HTTPcURLJavaScriptPython

GET /api/v2/score/userId?userId=1 HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "score": 1,
  "level": "untrusted"
}

Get scores by multiple userIds

post

Body

application/json

userIdsinteger[]Required

Responses

200

Successful response

application/json

400

Invalid input data

application/json

500

Internal server error

application/json

post/score/userIds

HTTPcURLJavaScriptPython

POST /api/v2/score/userIds HTTP/1.1
Host: api.ethos.network
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "userIds": [
    1
  ]
}

{
  "ANY_ADDITIONAL_PROPERTY": {
    "score": 1,
    "level": "untrusted"
  }
}

Get score by userkey

get

Query parameters

userkeystringRequired

triggerCalculationbooleanOptional

Responses

200

Successful response

application/json

scorenumber · max: 2800Optional

levelstring · enumRequiredPossible values:

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get/score/userkey

HTTPcURLJavaScriptPython

GET /api/v2/score/userkey?userkey=text HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "score": 1,
  "level": "untrusted"
}

Get scores by multiple userkeys

post

Body

application/json

userkeysstring[]Required

triggerCalculationbooleanOptional

Responses

200

Successful response

application/json

400

Invalid input data

application/json

500

Internal server error

application/json

post/score/userkeys

HTTPcURLJavaScriptPython

POST /api/v2/score/userkeys HTTP/1.1
Host: api.ethos.network
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "userkeys": [
    "text"
  ],
  "triggerCalculation": true
}

{
  "ANY_ADDITIONAL_PROPERTY": {
    "score": 1,
    "level": "untrusted"
  }
}

Check score calculation status

get

Query parameters

userkeystringRequired

Responses

200

Successful response

application/json

statusstring · enumRequiredPossible values:

isQueuedbooleanRequired

isCalculatingbooleanRequired

isPendingbooleanRequired

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get/score/status

HTTPcURLJavaScriptPython

GET /api/v2/score/status?userkey=text HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "status": "idle",
  "isQueued": true,
  "isCalculating": true,
  "isPending": true
}

Get aggregated score history from TimescaleDB

get

Query parameters

userkeystringRequired

durationstring · enumOptionalDefault: 30dPossible values:

Responses

200

Successful response

application/json

datestringRequired

scorenumberRequired

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get/score/history

HTTPcURLJavaScriptPython

GET /api/v2/score/history?userkey=text HTTP/1.1
Host: api.ethos.network
Accept: */*

[
  {
    "date": "text",
    "score": 1
  }
]

Get supporter penalties with enriched slash/subject data

get

Path parameters

profileIdinteger · max: 2147483647Required

Responses

200

Successful response

application/json

idnumberRequired

slashIdnumberRequired

penaltyAmountnumberRequired

createdAtstringRequired

reasonstring · enumRequiredPossible values:

slashobjectRequired

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get/slash/supporter-penalties/{profileId}

HTTPcURLJavaScriptPython

GET /api/v2/slash/supporter-penalties/{profileId} HTTP/1.1
Host: api.ethos.network
Accept: */*

[
  {
    "id": 1,
    "slashId": 1,
    "penaltyAmount": 1,
    "createdAt": "text",
    "reason": "vouch",
    "slash": {}
  }
]