Skip to content

Check score calculation status

GET
/score/status
curl --request GET \
--url 'https://api.ethos.network/api/v2/score/status?userkey=example'

Reports whether a score calculation is queued or running for a userkey. Poll this after requesting a lookup with triggerCalculation=true. The job is enqueued in the background, so an immediate poll can still say idle. Poll every second or so for a bounded period, such as ten seconds; once status is idle after that window, fetch the score again.

userkey
required
string

Successful response

Media typeapplication/json
object
status
required
string
Allowed values: idle queued calculating
isQueued
required
boolean
isCalculating
required
boolean
isPending
required
boolean

Example

{
"status": "idle"
}

Invalid input data

Media typeapplication/json
Invalid input data error (400)

The error information

object
message
required

The error message

string
code
required

The error code

string
issues

An array of issues that were responsible for the error

Array<object>
object
message
required
string

Example

{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}

Not found

Media typeapplication/json
Not found error (404)

The error information

object
message
required

The error message

string
code
required

The error code

string
issues

An array of issues that were responsible for the error

Array<object>
object
message
required
string

Example

{
"code": "NOT_FOUND",
"message": "Not found",
"issues": []
}

Internal server error

Media typeapplication/json
Internal server error error (500)

The error information

object
message
required

The error message

string
code
required

The error code

string
issues

An array of issues that were responsible for the error

Array<object>
object
message
required
string

Example

{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}