System

Health check endpoint

get

Responses

200

Successful response

application/json

500

Internal server error

application/json

get

/healthcheck

HTTPcURLJavaScriptPython

GET /api/v2/healthcheck HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "ok": true
}

Authenticated health check endpoint

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful response

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

get

/healthcheck/authenticated

HTTPcURLJavaScriptPython

GET /api/v2/healthcheck/authenticated HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ok": true,
  "profileId": 1
}

Always fail health check endpoint with 418 teapot

get

Responses

200

Successful response

application/json

Responseany

500

Internal server error

application/json

get

/healthcheck/always-fail

HTTPcURLJavaScriptPython

GET /api/v2/healthcheck/always-fail HTTP/1.1
Host: api.ethos.network
Accept: */*

No content

Wait until a blockchain transaction has been processed

get

Waits until the transaction has been processed by Ethos event processors or until the timeout elapses. > ⚠️ Warning: This is a beta endpoint. It is not guaranteed to be stable and may change or break without notice.

Path parameters

txHashstringRequired

Query parameters

timeoutMsinteger · max: 25000OptionalDefault: 10000

Responses

200

Successful response

application/json

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/transactions/{txHash}/processed

HTTPcURLJavaScriptPython

GET /api/v2/transactions/{txHash}/processed HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "processed": true,
  "status": "not_found"
}