Skip to content

Health Check

Unstable endpoints

These endpoints are diagnostic utilities, not part of the stable API contract. Their paths, response fields, and behavior may change or be removed without notice. Do not build business logic on their responses.

All requests require authentication via the Authorization: Bearer clientId:apiKey header.

Sandbox base URL: https://api-sandboxdash.norcapsecurities.com — the examples read it from $TAPI_HOST.

Endpoints

GET /v3/ping

Confirms the API is reachable and your credentials are valid.

Example Request

curl -X GET "$TAPI_HOST/v3/ping" \
  -H "Authorization: Bearer $TAPI_CLIENT_ID:$TAPI_API_KEY"

Response

Field Type Description
status string Always ok

Example Response

{
  "status": "ok"
}

GET /v3/status

Returns the server time, deployed version, and environment name.

Example Request

curl -X GET "$TAPI_HOST/v3/status" \
  -H "Authorization: Bearer $TAPI_CLIENT_ID:$TAPI_API_KEY"

Response

Field Type Description
timestamp string Current server time, ISO 8601
version string Identifier of the deployed build
environment string Name of the environment serving the request
flags null Reserved. Always null

Example Response

{
  "timestamp": "2026-09-23T14:05:12+00:00",
  "version": "48875bebb",
  "environment": "staging",
  "flags": null
}