Upcoming Changes to Batch Endpoints

We are excited to announce upcoming improvements being made to our Batch API endpoints! As part of our commitment to delivering the best developer experience, we will be introducing new versioned Batch endpoints under the /markets prefix by the end of March 2025 (or sooner). These changes will provide a more consistent and intuitive URI structure, improved usability, and enhanced scalability.

What’s Changing?

New Endpoint Structure

• The legacy Batch endpoints (e.g., market/options/open-interest/exchange/{exchange}/historical) will be replaced by new versioned endpoints using the /markets prefix and a streamlined naming convention:
  • Example: market/options/open-interest/exchange/{exchange}/historical → /markets/options/batch-open-interest/{exchange}

Parameters

• The new endpoints will support the following parameters (instruments, startDate, endDate, timeInterval, timeFormat) and will remain functional with the following changes:
  • pair becomes instruments
  • exchange is a required path parameter
  • instruments is a required parameter
  • The startDate and endDate parameters cannot retrieve data older than 62 days. Any requests attempting to access data beyond this limit will result in an error. Default behavior will change to return only the previous 62 days of data.
  • timeInterval will no longer accept tick or ticks (only minutes, hours, days)
  • timeFormat remains unchanged (keep existing functionality)
  • All new endpoints will use pagination (next URL)
  • All new endpoints accept two new headers (same functionality as the other new versioned endpoints):
    • api-version
    • Accept-Encoding

Deprecation Timeline

We recommend all customers begin migrating to the new endpoints as soon as they are available to take full advantage of the enhancements.

Affected Endpoints

The following legacy endpoints will be replaced:

What You Need to Do

• Update your API calls to use the new /markets endpoints once they are available.
• Review your applications and ensure compatibility with the new endpoint structure.
• Test the new endpoints during the migration period to confirm they meet your requirements.

Support

If you have any questions or need assistance during this transition, our support team is here to help. Contact us at [email protected].

Thank you for using our APIs. We are confident these improvements will enhance your experience and look forward to your feedback!