Skip to content

Hydrobit API (2.0.0)

Comprehensive API documentation for the Hydrobit platform.

This API enables management of forms, records, workers, projects, and related data within Hydrobit.

Authentication

  • User endpoints: Require a JWT in the Authorization header (Bearer token).

Features

  • Form management and record submission
  • Project and sector data retrieval
  • Worker management and operations
  • Production session and record management

Note: API access is available for Corporate accounts. For access or support, contact support@hydrobit.ag.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL
https://hydrobit.ag
Hydrobit Support
support@hydrobit.ag
License
Proprietary
Languages
Servers
Mock server
https://docs.hydrobit.ag/_mock/spec/openapi/
Production server
https://api.hydrobit.ag/
IoT server
https://iot.hydrobit.ag/
MQTT over WebSocket endpoint
wss://iot.hydrobit.ag/

Forms

Endpoints for form management and record submission

Operations

Projects

Endpoints for project and sector data retrieval

Operations

Workers

Endpoints for worker management and operations

Operations

Production Sessions

Endpoints for managing production sessions (open, close, update)

Operations

Production Records

Endpoints for creating and managing production records

Operations

Phytosanitary

Endpoints for phytosanitary monitoring and analysis (pest/disease tracking)

Operations

Get phytosanitary monitoring summary

Request

Retrieves aggregated phytosanitary data (pest and disease incidence/severity) for a specified time range.

Requires API token authentication with read:phytosanitary scope via the x-api-key header.

Key features:

  • Aggregates data from phytosanitary form records
  • Supports filtering by company, project, or sector
  • Returns incidence and severity metrics per sector
  • Maximum range: 180 days
  • Dates must be in YYYY-MM-DD format (local time, no timezone suffix)
  • Timezone is automatically resolved from the project settings
Security
apiKeyAuth
Query
companyIdstring

Company identifier (at least one of companyId, projectId, or sectorId is required)

Example: companyId=comp_12345
projectIdstring

Project identifier (at least one of companyId, projectId, or sectorId is required)

Example: projectId=proj_123
sectorIdstring

Sector identifier (at least one of companyId, projectId, or sectorId is required)

Example: sectorId=sector_001
startTimestring^\d{4}-\d{2}-\d{2}$required

Start date in YYYY-MM-DD format (local time, no timezone suffix)

Example: startTime=2025-10-01
endTimestring^\d{4}-\d{2}-\d{2}$required

End date in YYYY-MM-DD format (local time, no timezone suffix)

Example: endTime=2025-10-09
curl -i -X GET \
  'https://docs.hydrobit.ag/_mock/spec/openapi/api/control/phytosanitary/summary?companyId=comp_12345&projectId=proj_123&sectorId=sector_001&startTime=2025-10-01&endTime=2025-10-09' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Phytosanitary summary retrieved successfully

Bodyapplication/json
statusstring
Example: "success"
scopestring

Scope of the query (company, project, or sector)

Enum"company""project""sector"
Example: "project"
rangeobject
projectTimezonestring

Timezone used for the project

Example: "America/Mexico_City"
filtersobject
totalRecordsinteger

Total number of phytosanitary form records

Example: 42
totalProjectsinteger

Total number of projects (only for company scope)

Example: 3
totalSectorsinteger

Total number of sectors (for project/sector scope)

Example: 5
projectsArray of objects(PhytosanitaryProject)

Projects with nested sectors (only for company scope)

sectorsArray of objects(PhytosanitarySector)

Sectors with phytosanitary data (for project/sector scope)

Response
application/json
{
  "status": "success",
  "scope": "sector",
  "range": {
    "startTime": "2025-10-01",
    "endTime": "2025-10-09"
  },
  "projectTimezone": "America/Mexico_City",
  "filters": {
    "companyId": null,
    "projectId": null,
    "sectorId": "sector_001"
  },
  "totalRecords": 12,
  "totalSectors": 1,
  "sectors": [
    { … }
  ]
}

Get phytosanitary summary for entire company

Request

Retrieves aggregated phytosanitary data (pest and disease incidence/severity) for all projects and sectors belonging to the authenticated company within a specified time range.

Requires API token authentication with read:phytosanitary scope via the x-api-key header.

Key features:

  • Automatically uses companyId from the authenticated API token
  • Aggregates data from all projects and sectors belonging to the company
  • Returns incidence and severity metrics grouped by project and sector
  • Maximum range: 180 days
  • Dates must be in YYYY-MM-DD format (local time, no timezone suffix)
  • Timezone is automatically resolved from the company's projects
  • No need to specify companyId, projectId, or sectorId manually
Security
apiKeyAuth
Query
startTimestring^\d{4}-\d{2}-\d{2}$required

Start date in YYYY-MM-DD format (local time, no timezone suffix)

Example: startTime=2025-10-01
endTimestring^\d{4}-\d{2}-\d{2}$required

End date in YYYY-MM-DD format (local time, no timezone suffix)

Example: endTime=2025-10-09
curl -i -X GET \
  'https://docs.hydrobit.ag/_mock/spec/openapi/api/control/phytosanitary/company-summary?startTime=2025-10-01&endTime=2025-10-09' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Company phytosanitary summary retrieved successfully

Bodyapplication/json
statusstring
Value"success"
Example: "success"
scopestring
Value"company"
Example: "company"
rangeobject
companyTimezonestring

Timezone resolved from company's projects

Example: "America/Monterrey"
companyIdstring

Company identifier from authenticated token

Example: "comp_12345"
totalRecordsinteger

Total number of phytosanitary records found

Example: 150
totalProjectsinteger

Total number of projects with data

Example: 2
projectsArray of objects
Response
application/json
{
  "status": "success",
  "scope": "company",
  "range": {
    "startTime": "2025-10-01",
    "endTime": "2025-10-09"
  },
  "companyTimezone": "America/Monterrey",
  "companyId": "comp_12345",
  "totalRecords": 150,
  "totalProjects": 2,
  "projects": [
    { … },
    { … }
  ]
}

Weather

Endpoints for weather and climate data retrieval

Operations

Plant

Endpoints for plant monitoring, growth, and health data

Operations

Irrigation

Endpoints for irrigation control, logs, and automation

Operations

IoT Endpoint

Endpoints for IoT devices, telemetry, and field data integration

Operations