Table of Contents
- API Usage Guide
- API Command Reference
- add_booking
- add_client
- add_invoice
- add_resource
- approve_request
- authenticate_user
- del_booking
- del_bookings
- del_client
- del_invoice
- del_resource
- email_client
- gen_invoice
- get_activity
- get_availability
- get_booking
- get_booking_type
- get_booking_types
- get_bookings
- get_client
- get_consumable_levels
- get_invoice
- get_invoices
- get_messages
- get_reminders
- get_resource
- get_resource_availability
- get_setting
- get_template
- get_user
- get_users_logged_in
- get_venue
- get_venue_groups
- get_venues
- get_venues_in_group
- get_venues_in_use
- get_watches
- mod_booking
- mod_client
- mod_invoice
- mod_resource
- mod_venue
- notify_user
- reject_request
- restore_booking
- set_setting
- set_template
- util_api_usage
- util_from_epoch
- util_to_epoch
- Appendix A - Activity Codes
- Appendix B - Setting Names
- Appendix C - Error Handling
- Code Samples
- Troubleshooting
- Release Notes
← Hide Table of Contents
MIDAS API: Usage Limits
MIDAS API: Usage LimitsIn order to ensure service quality for all our cloud-hosted customers, we have a "fair usage" policy in place in relation to making API calls.
API call frequency limits
We employ rate-limiting on inbound traffic to our servers.To avoid hitting these limits, please ensure that you limit the frequency of API calls to your cloud-hosted MIDAS system.
An excessively high frequency of API calls may result in your IP address being automatically blocked and/or your API access being suspended.
API bandwidth limits
The MIDAS API is capable of returning very large data sets.Customers routinely making API calls which return extremely large data sets may result in their API access being suspended.
You should therefore carefully consider the parameters you pass along with your API calls to ensure that they restrict the data set being returned to the minimum amount of information you require.
What happens if I exceed these limits?
If you exceed these limits, API access to your MIDAS system will be temporarily suspended, with subsequent API calls returning an error. API access will be automatically re-instated once API usage falls below these limits again.For advice on reducing your API usage to avoid hitting these limits, please see our KB article: How to reduce API usage.
Can I monitor my API usage?
From API v4.28+, you can view your current API usage via MIDAS Admin Options → Manage Addons → API Access.API usage may also be monitored directly through the API itself via the new "util_api_usage" call.
Can I increase these limits?
We believe the frequency/bandwidth limits outlined above are fair, and will not impact the vast majority of API users.However, if you are regularly exceed these limits and are unable to refactor your code to reduce the frequency of API requests and/or the amount of data returned by your API calls, then please contact us. We may be able to increase your limits for an additional charge.
Alternatively, you may like to consider migrating to a self-hosted MIDAS system. API calls to self-hosted MIDAS systems do not have any usage limits imposed.