Versioning & Changelog
BEAM® Data API is designed to constantly evolve. We use date-based client compatibility versioning for all Data API endpoints. This means that when the client makes an API call, it must send a fixed date in the past (e.g., 2024-04-24), typically the date when the client code was written and tested. This ensures that while we roll out new features, the behavior of API endpoints remains unchanged for existing clients.
Avoid passing the current date to the API. While it may seem like you are outsmarting the system, it only guarantees your client will fail in the future when the schema or endpoint name changes. Instead, visit this page often and read through the changelog. Breaking changes will be highlighted, so you can skip reading updates that do not impact you. Once you are sure your code won't break - advance the date and redeploy.
Older versions will degrade in performance over time, as performance optimizations won't apply to them, and fewer server instances will be running the old code. Be sure to revise the compatibility date of your running code at least once per quarter.
Versioning
- cURL
- Node.js
curl 'https://api.beamstream.gg/channels/376607189608962159' \
-H 'BEAM-Version: 2024-04-24'
import { Client as BEAMClient } from '@beamstream/data-api'
const beam = BEAMClient('<YOUR_API_KEY>', {
apiVersion: '2024-04-24',
})
const channel = beam.channels.retrieve(376607189608962159n)
Breaking Changes
There are no breaking changes, yet.
Changelog
There are no public changes, yet.