Batch Market Data Subscription
Subscribe many users to market data in one call.
Available to: Organization administrators (users in their organization)
Environments: Live
Rate Limit: No endpoint-specific limit
Subscribe several users in your organization to market data plans in a single request. Each entry in subscriptions names one user (userId), the plans (marketDataSubscriptionPlanIds), the month (year, month), and how to pay (accountId or creditCardId). Each entry works like addMarketDataSubscription for that user, including its payment rules.
The whole batch is checked first. If the batch is rejected, the response has a top-level errorText and errorCode, results is empty, and nothing is charged. Otherwise each entry is processed on its own: results has one entry per user, in request order, with that user’s marketDataSubscription on success (the last one created, when the entry names several plans) or its own errorText and errorCode on failure. The response also returns a batchSubmissionId.
Common Failure Scenarios
- Whole batch rejected: you aren’t an organization administrator; the batch is larger than the configured maximum; an entry has no
userId, or a user appears more than once; or a user, account, or card in the batch isn’t available to you (the message lists the IDs). - One entry rejected: the entry names more plans than the configured maximum, or repeats a plan; a field is out of range; or the entry fails for any of the reasons
addMarketDataSubscriptionlists (payment, plan availability, live account, conflicts, balance, card charge). - Outcome unknown: processing an entry took too long. The user may have been charged, so check the user’s subscriptions before retrying that entry.
subscriptionsis empty. This returnsHTTP 400.- You call it on Demo. This returns
HTTP 501.
This endpoint returns HTTP 200 for both successful and rejected requests, so check the top-level errorText and each entry’s errorText in results to confirm the result. Other failures, such as denied access or an invalid request, return their own HTTP status.
Error Messages
Related Endpoints
- Use
addMarketDataSubscriptionto subscribe a single user.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
Response
Non-empty if the request failed