## Get API health status

`client.status.checkHealth(RequestOptionsoptions?): StatusCheckHealthResponse`

**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.

### Returns

- `StatusCheckHealthResponse`

  API health response

  - `status: "ok"`

    - `"ok"`

### Example

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

const client = new NeptuneAPIV2();

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

console.log(response.status);
```

#### Response

```json
{
  "status": "ok"
}
```