SDK Reference v2.0.0 / APIRateLimit

APIRateLimit

struct APIRateLimit

Information about MyDataHelps API request limits (throttling). The MyDataHelps API has a rate limiting feature to preserve stability for all customers. Failures due to rate limiting are indicated by the MyDataHelpsError.tooManyRequests error case.

The properties of APIRateLimit help you understand your rate limits and usage, which may vary based on project licensing and scope. See Rate Limits documentation for additional information.


maxRequestsPerHour
let maxRequestsPerHour: Int

Number of requests allowed per hour (total) for this scope.

remainingRequests
let remainingRequests: Int

Number of requests remaining this hour for this scope.

nextReset
let nextReset: Date

When the rate limit will be reset. If your API interactions are failing with the tooManyRequests error, they should work again if you retry after the nextReset date.