Skip to content
Neptune API v2
Get started
API Reference
Status

Get API health status

client.status.checkHealth(RequestOptionsoptions?): StatusCheckHealthResponse { status }
GET/api/v1/status/health

status will always be ok whenever a 200 response is provided.

Clients can check response data or response status code to confirm health.

ReturnsExpand Collapse
StatusCheckHealthResponse { status }

API health response

status: "ok"

Get API health status

import NeptuneAPIV2 from '@neptunefinance/api-v2';

const client = new NeptuneAPIV2();

const response = await client.status.checkHealth();

console.log(response.status);
{
  "status": "ok"
}
Returns Examples
{
  "status": "ok"
}