Growbud API Reference
Integrate Growbud sensor data with your tools and systems
New to the API?
Start with the quickstart guide. It includes step-by-step code examples.
Get API credentials
Generate tokens and monitor usage in the Growbud web app.
Interactive API documentation
Browse every endpoint. Inspect request and response schemas. Review parameters, response formats, and error codes.
API Explorer
Browse endpoints and view request and response schemas
Authentication & API credits
The Growbud API uses bearer token authentication. Generate and manage tokens in the Growbud web app. Each API call uses credits based on the endpoint and data volume.
API pricing
Pricing is pay as you go. Each successful request deducts a small amount from your USD balance. Paid responses include the X-API-Balance-USD header so you can track the remaining balance in code.
/api/list-sensors$0.0001
/api/thresholds (GET)$0.0005
/api/latest$0.0005
/api/thresholds (PUT)$0.001
/api/thresholds/batch$0.001 + $0.0005 x each update
/api/query$0.0001 + $0.00001 x hours
SMS Notification$0.02
| Endpoint / Operation | Cost (USD) |
|---|---|
/api/list-sensors | $0.0001 |
/api/thresholds (GET) | $0.0005 |
/api/latest | $0.0005 |
/api/thresholds (PUT) | $0.001 |
/api/thresholds/batch | $0.001 + $0.0005 x each update (max 50) |
/api/query | $0.0001 + $0.00001 x hours (max $0.0217) |
SMS Notification (non-subscribed users) | $0.02 |
When your API balance is empty, requests return HTTP 402 Payment Required with the message "API balance exhausted. Please recharge your account."
API tokens
- •Generate multiple tokens for different applications
- •Set expiration dates for security
- •Revoke tokens immediately if compromised
Credit system
- •Pay-as-you-go pricing
- •Balance shown in response headers
- •Usage analytics in the web app
Note: Create an account in the Growbud mobile app first. Then sign in at growbud.app to access API features.
API endpoints overview
GET /api/balance
Check your current API credit balance in USD.
GET /api/list-sensors
List all sensor serial numbers accessible to your account.
GET /api/query
Query historical sensor data by time range. Returns JSON or CSV.
GET /api/latest
Get the most recent readings from your sensors, including device status.
Response headers
API responses include headers with metadata about the request:
X-API-Balance-USDYour remaining API credit balance
X-API-Cost-USDCost of the current request
X-Rate-Limit-RemainingRequests remaining in current window
X-Rate-Limit-ResetUnix timestamp when rate limit resets
| Header | Description |
|---|---|
X-API-Balance-USD | Your remaining API credit balance |
X-API-Cost-USD | Cost of the current request |
X-Rate-Limit-Remaining | Requests remaining in current window |
X-Rate-Limit-Reset | Unix timestamp when rate limit resets |
Error handling
The API uses standard HTTP status codes. Error messages return in JSON format:
401 UnauthorizedInvalid or missing token402 Payment RequiredInsufficient API credits429 Too Many RequestsRate limit exceeded500 Internal Server ErrorServer error, please retryReady to integrate with Growbud?
Start with the quickstart guide, or open the full documentation.