Basics

Endpoint Structure

All REST API endpoints are accessed via the base URL:

https://api.finlight.me

Endpoints are structured using standard HTTP methods and expect parameters to be sent as query strings.

The REST API is versioned to ensure backward compatibility. The current version is v1. All endpoints include the version number in the URL:

https://api.finlight.me/v1/...

This allows for future updates without breaking existing integrations.

Authenticate your REST API requests by including your API key in the X-API-KEY header:

X-API-KEY: YOUR_API_KEY

If you're using our client libraries, this header is automatically handled for you. You can grab your API key in the Finlight Dashboard.