---
title: "Ping the API"
method: GET
path: "/v1/ping"
tags: ["health"]
---

# Ping the API

`GET /v1/ping`

## Request

- Base URL: `https://api.fxmacrodata.com`
- URL: `https://api.fxmacrodata.com/v1/ping`
- Auth: one of:
  - none
  - API key in header `X-API-Key`
  - HTTP bearer

Returns a simple OK status to verify the API is running.

## Response `200`

Health-check response confirming API availability.

- ServiceStatusResponse: Liveness payload shared by ``/v1/ping`` and ``/v1/health``.
  - `status` string, required
  - `service` string, required

---

[API](https://skmtc.dev/fxmacrodata/apis/fx-macrodata-api.md) · [All operations](https://skmtc.dev/fxmacrodata/apis/fx-macrodata-api/llms.txt) · [OpenAPI document](https://skmtc.dev/fxmacrodata/apis/fx-macrodata-api/revisions/fadaa543b154?raw)