Introduction

Welcome to the Spark API guide. This handbook provides a complete, plain-English description of the API's functionality. It's coding language agnostic, so you can use it whether you're working with Python, R, or any other programming language.

Have feedback? We'd love to hear from you, especially if anything is unclear or missing. Contact us at support@sparkcommodities.com

What is the Spark API?

The Spark API lets you access Spark data, import it to your system, and analyze it using your preferred tools. Your data access depends on your subscription tier:

Subscription Type	Access Level
Premium API	Full access to all Spark data
Trial	Latest releases, limited access to historical data

Upgrade to Premium

Want complete access to the Spark dataset? Contact our commercial team at commercial@sparkcommodities.com

Important: Your API access is also platform-specific. For example, a Premium API subscription to Spark Freight doesn't include Spark Cargo data unless you have that subscription too.

Download OpenAPI Specification

Getting Started

Follow these three steps to start using the API:

Step 1: Register Your Application

Create an OAuth2 client for your application in the Manage OAuth2 Clients dashboard.

How to register:

1. Enter a Client Name - Choose a descriptive name to help you identify this application later
2. Download your credentials - Save these securely; you'll need them for authentication

Platform Access Required

You need a Spark account to register applications. Log in or Sign up to get started.

Step 2: Authenticate

Before making API requests, your application must authenticate using the credentials from Step 1 to obtain an access token.

Next: Follow the detailed Authentication Guide

Step 3: Start Fetching Data

Once you have your access token, you can make requests to any Spark API endpoint by including the token with your requests.