Dashboard

Profile for the authenticated API key

Returns the caller's key prefix, email, mode (live or test), and issue time. Requires a self-serve issued key — admin keys receive 403.

get/v1/me

Request

  • Base URL: https://api.farofinance.app
  • URL: https://api.farofinance.app/v1/me
  • Auth: none declared

Response

Successful Response

key_prefixstring required

Non-secret key identifier, e.g. faro_live_AbC123.

emailstring required

Email the key was issued to.

modestring required

Key mode: live or test.

created_atstring date-time required

When this key was issued.

labelstring nullable

Optional human label for the key.

Changes

No recorded changes to this operation across all 1 revision of this API.