Introducing Data Versioning for Query API Datasets
We are excited to announce the introduction of Data Versioning for all Query endpoints on the FINRA API Platform, effective today. This enhancement demonstrates our commitment to providing a stable, reliable API experience while continuing to evolve our data offerings.
What is Data Versioning?
Data versioning allows us to make improvements and updates to our API responses while maintaining backward compatibility for your existing integrations. This means your applications will continue to work seamlessly, even as we enhance our data structures and add new capabilities.
Key Benefits
- Backward Compatibility: Your existing integrations remain functional
- Controlled Transitions: Minimum 6-month support windows for version changes
- Predictable Updates: Clear distinction between breaking and non-breaking changes
- Enhanced Stability: No unexpected disruptions to your applications
Key Points
- No Action Required: Your existing applications will continue to work exactly as they do today.
- Version Control: Use data-version in request header to specify versions (e.g., data-version: 1)
- Dataset details: Get version details for all Query datasets using the new datasets resource endpoint
- Stability: Minimum 6-month support for each version
- Default Behavior: No header = oldest supported version
How It Works
All current APIs start at version 1. When we make non-backward-compatible changes, we'll increment the version number while keeping your current version available.
To learn more about Data Versioning and Version Change Criteria, see here.