CricketOps API Documentation: Integrating Your Cricket Farm Data

CricketOps API supports RESTful integration with existing farm management systems and ERP platforms. If you're a technical buyer running a larger operation -- or a developer building a custom integration -- this guide covers the available endpoints, authentication, and common integration use cases.

TL;DR

• Custom dashboard with live bin status: Poll GET /api/v1/bins on a 15-minute interval
• API calls are rate-limited to 100 requests per minute per API key at the Enterprise tier
• Set up polling at 15-minute or hourly intervals for near-real-time data, or daily batch pulls for end-of-day reporting
• Monthly production report to ERP: Schedule a GET /api/v1/metrics/harvest call for the prior month on the 1st of each month
• Custom dashboard with live bin status: Poll GET /api/v1/bins on a 15-minute interval
• Register a webhook endpoint via the POST /api/v1/webhooks endpoint to receive real-time event notifications when CricketOps alerts fire
• When evaluating software, confirm which sensor brands and communication protocols (WiFi, Zigbee, 4G) are supported before purchasing equipment

Core Endpoints

Bins

GET /api/v1/bins

Returns all bins in your account with their current status.

• Includes total feed input, harvest yield, and FCR value.

Production Metrics

GET /api/v1/metrics/fcr

Returns FCR summary across all bins for a specified date range.

• Includes count-based and percentage-based die-off metrics.

GET /api/v1/metrics/harvest

Returns harvest yield data by bin and date range.

• Query parameters: start_date, end_date, resolution (hourly, daily).

POST /api/v1/zones/{zone_id}/sensor_data

Push sensor readings from external systems into CricketOps.

• When a zone trips a temperature threshold, the alert appears in Slack within seconds.

Custom dashboard with live bin status: Poll GET /api/v1/bins on a 15-minute interval.

• Combine with your financial data for a unified operations view.

Rate Limits and Support

API calls are rate-limited to 100 requests per minute per API key at the Enterprise tier.

• Set up polling at 15-minute or hourly intervals for near-real-time data, or daily batch pulls for end-of-day reporting.

Overview: Why Use the CricketOps API?

Most cricket farm operators manage everything directly through the CricketOps dashboard. The API is for teams that need to connect CricketOps data to other systems:

• ERP integration: Pull CricketOps production data (yield by batch, FCR, production volume) into your accounting or ERP platform for financial reporting
• Custom dashboards: Build a proprietary operational dashboard that displays CricketOps data alongside other farm data sources
• Automated reporting: Schedule report generation and distribution without manual intervention
• Third-party sensor systems: Push environmental data from external sensor systems into CricketOps for centralized logging
• Webhook-based alerting: Route CricketOps alerts into your existing notification infrastructure (Slack, PagerDuty, email systems)

The API is available at the Enterprise tier. Contact the CricketOps team for access credentials and base URL details for your account.

Authentication

CricketOps uses API key authentication. Include your API key in the request header:

Authorization: Bearer YOUR_API_KEY

API keys are generated in your CricketOps account settings under Developer > API Access. Each key can be scoped to read-only or read-write access and to specific data domains (bins, environmental data, production reports).

Security note: Treat your API key as a password. Don't include it in client-side code, version control repositories, or shareable documents. Rotate keys if you suspect they've been exposed.

Core Endpoints

Bins

GET /api/v1/bins

Returns all bins in your account with their current status.

Key response fields:

• bin_id (string): Your assigned bin identifier
• species (string): Cricket species (e.g., "acheta_domesticus")
• hatch_date (ISO 8601 date)
• life_stage (enum: pinhead, juvenile, adult, pre_harvest)
• current_stocking_count (integer): Adjusted for logged die-offs
• zone_id (string): Environmental zone assignment

GET /api/v1/bins/{bin_id}

Returns full lifecycle data for a single bin, including all logged feed events, mortality events, and environmental zone association.

GET /api/v1/bins/{bin_id}/fcr

Returns the calculated FCR for a bin (available once harvest is logged). Includes total feed input, harvest yield, and FCR value.

Production Metrics

GET /api/v1/metrics/fcr

Returns FCR summary across all bins for a specified date range. Query parameters:

• start_date (ISO 8601)
• end_date (ISO 8601)
• species (optional filter)
• zone_id (optional filter)

GET /api/v1/metrics/dieof

Returns die-off rate summary by bin or by zone for a specified date range. Includes count-based and percentage-based die-off metrics.

GET /api/v1/metrics/harvest

Returns harvest yield data by bin and date range. Includes yield in grams, production duration (hatch to harvest), and batch-level summary statistics.

Environmental Data

GET /api/v1/zones/{zone_id}/environmental

Returns temperature and humidity logs for a zone over a specified period. Query parameters: start_date, end_date, resolution (hourly, daily).

POST /api/v1/zones/{zone_id}/sensor_data

Push sensor readings from external systems into CricketOps. Body format:

{
  "timestamp": "2026-02-25T14:30:00Z",
  "temperature_f": 88.2,
  "humidity_rh": 68.5,
  "sensor_id": "SENSOR_001"
}

Alerts

GET /api/v1/alerts

Returns all currently active alerts and alert history.

POST /api/v1/webhooks

Register a webhook endpoint to receive CricketOps alerts in real time. Body format:

{
  "url": "https://your-system.com/webhooks/cricketops",
  "events": ["temperature_alert", "harvest_window_open", "task_overdue"],
  "secret": "YOUR_WEBHOOK_SECRET"
}

Webhook payloads include event type, timestamp, affected entity (bin or zone), and current metric values.

Common Integration Patterns

Monthly production report to ERP: Schedule a GET /api/v1/metrics/harvest call for the prior month on the 1st of each month. Map fields to your ERP's production record schema. Automate with a cron job or workflow automation tool.

Real-time temperature alerts to Slack: Register a webhook for the temperature_alert event. Write a lightweight webhook receiver that formats the payload and posts to your Slack channel. When a zone trips a temperature threshold, the alert appears in Slack within seconds.

Custom dashboard with live bin status: Poll GET /api/v1/bins on a 15-minute interval. Display bin life stage, die-off rate, and days to harvest in your custom interface. Combine with your financial data for a unified operations view.

Rate Limits and Support

API calls are rate-limited to 100 requests per minute per API key at the Enterprise tier. Higher rate limits are available for specific integration use cases -- contact support if your integration requires higher throughput.

For full API reference documentation including all available query parameters and response schemas, see your CricketOps account's Developer documentation. Contact the CricketOps enterprise team for integration support.

Frequently Asked Questions

What CricketOps API endpoints are available for developers?

The core endpoint categories are: Bins (list all bins, get individual bin detail, get calculated FCR per bin), Production Metrics (FCR summary, die-off rate summary, harvest yield data by date range), Environmental Data (temperature and humidity logs per zone, and an endpoint for pushing external sensor data into CricketOps), and Alerts (active alert history, and webhook registration for real-time event delivery). All endpoints use RESTful conventions with JSON responses. The API is available at the Enterprise tier.

Can I pull my CricketOps data into my own dashboard?

Yes. Use the production metrics and bin status endpoints to pull current and historical production data into any custom dashboard or reporting environment. Common integrations pull monthly FCR summaries, die-off rates by zone, and harvest yield data into ERP systems or custom business intelligence platforms. Set up polling at 15-minute or hourly intervals for near-real-time data, or daily batch pulls for end-of-day reporting. Authentication uses a static API key included in the Authorization header.

Does CricketOps support webhook alerts for external systems?

Yes. Register a webhook endpoint via the POST /api/v1/webhooks endpoint to receive real-time event notifications when CricketOps alerts fire. Supported events include temperature threshold breaches, harvest window openings, and task overdue notifications. Webhook payloads include the event type, timestamp, affected entity, and current metric values. You can route these webhooks into any notification system that accepts HTTP POST requests -- Slack, PagerDuty, email relay services, or your own custom alerting infrastructure.

What data should a cricket farm management system track at minimum?

At minimum: bin identification, population counts by life stage, feed inputs and quantities, mortality events, temperature and humidity readings, and harvest dates and weights. These categories give you enough data to calculate FCR, identify underperforming bins, and audit any production batch. More advanced tracking adds environmental sensor integration, financial cost allocation, and buyer order fulfillment records.

How long does it take to see a return on investment from farm management software?

Operations that move from spreadsheets to purpose-built software typically see measurable FCR improvement within two to three production cycles, as patterns invisible in manual records become visible in aggregated data. The timeline depends on operation size -- larger farms benefit faster because there are more data points and more decisions that can be improved. The ROI accelerates when the software also reduces the time spent on manual data entry and reporting.

Can cricket farm management software integrate with environmental sensors?

Yes, platforms designed specifically for commercial insect production such as CricketOps support direct integration with temperature and humidity sensors via IoT protocols. This eliminates the need for manual environmental logging and enables automated alerts when readings fall outside set thresholds. When evaluating software, confirm which sensor brands and communication protocols (WiFi, Zigbee, 4G) are supported before purchasing equipment.

Sources

• Food and Agriculture Organization of the United Nations (FAO) -- Edible Insects: Future Prospects for Food and Feed Security
• North American Coalition for Insect Agriculture (NACIA)
• Entomological Society of America
• USDA Agricultural Research Service
• AgriNovus Indiana -- AgTech Industry Resources

Get Started with CricketOps

Managing a cricket operation with disconnected tools -- a spreadsheet for bins, a separate doc for feed logs, manual temperature notes -- creates gaps in your data that become costly blind spots. CricketOps brings bin tracking, environmental monitoring, FCR calculations, and harvest records into one place built specifically for insect agriculture. Try it and see how much clearer your production picture becomes.