Haikubox API Documentation

Haikubox provides an easy-to-use REST API for interacting with your Haikubox devices. Haikubox listens to your environment and reports when it hears your birds. This documentation will guide you through making requests to the Haikubox API.

Endpoints

1. Get Specific Haikubox Information

This endpoint retrieves information about a specific Haikubox by its serial code.

  • URL: /haikubox/<SERIAL_CODE>
  • Method: GET
  • URL Parameters: <SERIAL_CODE>=[alphanumeric] (serial code of your Haikubox)
  • Example: https://api.haikubox.com/haikubox/1000000066e59043

2. Get Daily Bird Count

This endpoint provides the daily counts for each of the bird species detected on your Haikubox for a specific day.

  • URL: /haikubox/<SERIAL_CODE>/daily-count
  • Method: GET
  • URL Parameters: <SERIAL_CODE>=[alphanumeric] (serial code of your Haikubox)
  • Query Parameters: date=[YYYY-MM-DD] (optional, date in format YYYY-MM-DD)
  • Example: https://api.haikubox.com/haikubox/1000000066e59043/daily-count?date=2023-05-17

3. Get Yearly Bird Count

This endpoint provides the yearly counts for each of the bird species detected on your Haikubox for a specific year. The counts are limited to the top 75 species for the year specified.

  • URL: /haikubox/<SERIAL_CODE>/yearly-count
  • Method: GET
  • URL Parameters: <SERIAL_CODE>=[alphanumeric] (serial code of your Haikubox)
  • Query Parameters: year=[YYYY] (optional, year in format YYYY)
  • Example: https://api.haikubox.com/haikubox/1000000066e59043/yearly-count?year=2023

4. Get Recent Detections

This endpoint provides a sample of recent detections from your Haikubox. By default, it returns up to 5 most recent detections per species in the last 8 hours. You can also specify a different time range up to the last 24 hours.

  • URL: /haikubox/<SERIAL_CODE>/detections
  • Method: GET
  • URL Parameters: <SERIAL_CODE>=[alphanumeric] (serial code of your Haikubox)
  • Query Parameters: hours=[integer] (optional, number of past hours to retrieve detections for, max 24)
  • Example: https://api.haikubox.com/haikubox/1000000066e59043/detections?hours=4

Rate Limits

Please be aware that there may be rate limits applied to the API requests to ensure the quality of service. If you encounter any issues or need higher limits, please contact our support team.

Support

For any issues or queries related to the API, please reach out to support@haikubox.com.

License

Data obtained using this API are licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. If you are using data from Haikubox for research purposes, please cite the following paper:


  @article{kahl2021birdnet,
	  title={BirdNET: A deep learning solution for avian diversity monitoring},
	  author={Kahl, Stefan and Wood, Connor M and Eibl, Maximilian and Klinck, Holger},
	  journal={Ecological Informatics},
	  volume={61},
	  pages={101236},
	  year={2021},
	  publisher={Elsevier}
	}