API Usage
Understanding API Usage Limits
Crudify provides a balanced approach to API usage, offering unlimited read operations while applying reasonable limits to write operations. This ensures service stability and availability for all users.
API Call Allocation
Monthly Allocation
Each user receives 500 API write calls per month, applicable across all projects. This allocation resets on the first day of each month.
What Counts as API Usage?
| HTTP Method | Counts Toward Usage Limit | Description |
|---|---|---|
| GET | No (Unlimited) | Retrieve resources (read operations) |
| POST | Yes | Create new resources |
| PATCH | Yes | Partially update resources |
| DELETE | Yes | Remove resources |
API Usage Example
If a user performs the following actions in a month:
- Creating 200 new todo items: 200 calls (POST)
- Updating 250 todo items: 250 calls (PATCH)
- Deleting 50 todo items: 50 calls (DELETE)
- Retrieving data 1,000 times: 0 calls (GET is free)
Total usage: 500 calls (Monthly limit reached)
What Happens When You Reach the Limit?
Once the 500-call limit is reached:
- Read Operations Continue: You can still use GET requests without any restrictions.
- Write Operations Restricted: POST, PATCH, PUT, and DELETE operations will be unavailable until the next monthly reset.
- Error Response: Attempts to make write operations will return an error:
{
"error": "API call limit exceeded for this month",
"status": 500
}Monitoring Your API Usage
You can track your API usage in the Usage Overview section of your Crudify account dashboard.
- API Requests: Displays the number of API calls used out of your total monthly limit.
- Real-Time Tracking: The progress bar visually represents your remaining API requests for the month.
Visit your Crudify account dashboard to manage and optimize your API usage effectively.
Important Usage Considerations
Cross-Project Allocation
- The 500-call limit applies across all projects under your account.
- Example: If you use 300 calls in Project A and 200 calls in Project B, you will reach your 500-call limit.
- GET operations remain unlimited for all projects.
Usage Best Practices
- Efficient Data Fetching: Filter GET requests using query parameters instead of fetching all data and filtering client-side.
- Test in Development: Use test environments to avoid consuming your live API allocation.
Maximizing Your Crudify API Experience
Crudify's API usage model is designed to support learning and development. By offering unlimited GET requests and a reasonable write operation limit, you can build and test applications efficiently.
For users needing higher limits, Crudify is exploring expanded API plans. If you have questions or require more usage, reach out to our support team.
Start building with Crudify today! 🚀