API Reference

This page will help you get started with the Synth API.

Our goal with the Synth API is to make it as simple as possible to get up and running with the various tools Synth offers around fintech data.

You can interact with the API through HTTP requests from any language.


Authentication

The Synth API uses API keys for authentication. Head over to your Synth account to retrieve the API key you want to use with your requests.

Remember that your API key is a secret! Do not share it with others or expose it in any client-side code (browsers, apps). Production requests must be routed through your own backend server where your API key can be securely loaded from an environment variable or key management service.

All API requests should include your API key in an Authorization HTTP header as follows:

Authorization: Bearer SYNTH_API_KEY

Example request

Here's an example curl command:

curl https://api.synthfinance.com/exchanges/nyse \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $SYNTH_API_KEY" \

This makes a request to the Exchanges endpoint and returns data about the specifically requested exchange (NYSE, in this example).

{
  "data": {
    "id": "157946c5-fcae-4578-b5a3-6a3261760fbe",
    "name": "Nyse Arca",
    "acronym": "NYSE",
    "mic_code": "ARCX",
    "city": "New York",
    "country_code": "US",
    "kind": "segment",
    "timezone": "America/New_York",
    "currency": "USD",
    "links": {
      "website": "https://www.nyse.com"
    }
  },
  "meta": {
    "credits_used": 1,
    "credits_remaining": 219
  }
}