API

[mcguirepr89]

I'm building this -- here is the POC
https://virginia.birdnetpi.com/api/detections

[ehpersonal38]

Looks good! What do you think the intended use case of the API is? People just wanting to make their own interface of sorts, or more for research groups to extract data to spreadsheets and such?

[mcguirepr89]

Just interfacing for other folks mostly

[MyosQ]

I would be very interested in this feature. For building a custom interface and for building an interface with overview over many devices. If I understand it correctly, now you can only view one device at a time in the web interface?

[mcguirepr89]

Thanks, @MyosQ for weighing in on adding the API. I would really like it if folks like yourself were to also weigh in on which interfaces (frameworks ?) you would be interested in using -- it can help me both with configuring the API and in preparing the repo for the new model to be built from scratch using the framework for which I've been presented the most compelling use case

[MyosQ]

My first thought was to do a dashboard of some sort. One single page that updates its content automatically. In it could be for example: species today, top 3 species this week and new species this week. You could also have graphs and other visualisations.

R shiny is quite handy for dashboards and would be my first choice. But I think react could also work.

[DaveBKC]

Would this allow users to grab data from the BirdNET-Pi local database? I'm interested in having a copy of that BirdNet data in my mariadb weather data database. From there I would import into Tableau.

[mcguirepr89]

Yes -- the POC in the api branch is not production ready, and only currently has one end-point configured which returns the entire database in JSON format. I need to figure the best server to use for production since I'm only just now getting familiar with Flask (Caddy will stand in front as the reverse_proxy).

[mcguirepr89]

It's also not active right now (I'm on the main branch currently)

[timsterc]

If this isn't the right place to mention this - please feel free to delete - or suggest where I might better share.

The goal with BirdWeather is to provide both live visualization, but also to be a fully open databank of all the detections uploaded. We're using GraphQL - so for those familiar with it:

• API - https://app.birdweather.com/api/index.html
• Online GraphQL Query Tool - https://app.birdweather.com/graphiql

We've also finished the first pass at our data explorer - https://app.birdweather.com/data - which also supports exporting results via CSV.

Cheers!
-Tim

[becausebirds]

Your API for BirdWeather is great! I'd be interested in requesting detections only for the current day, instead of having the 24-hour rolling time period only. I built a digital counter and am using it to display the detection count and latest species detected. It would be amazing to see just the day's data on it!

[London-Lass]

I'm involved with a livestream of wildlife in Scotland using OBS (Birds, Mammals etc) and think that integrating with BirdNET would be a a fantastic feature. We already allow users to spot birds etc, with an index being created, and videos created with thumbnails of species. (For anyone interested, search Youtube for "Scottish Wildlife Garden" if you want to see the livestream,)

What is the current status of the API available for BirdNET-Pi so that I might on say query over a period of time which species have been heard, so that this can then be shared with viewers? The initial comment on this discussion suggests that it just returns the entire database in json format. Any progress since then?

[ehpersonal38]

This looks like a cool project! I've seen a few livestreams like this on YouTube before and think they're pretty neat.

The current status of the API for BirdNET-Pi is that it's non-existent. However, I think it'd be easy enough to code up something that would meet your use-case. So, let me know what format you need (json, csv, something else?) and I'll try to get some type of rudimentary API worked up. Also do you currently have a BirdNET-Pi installation up and running?

[London-Lass]

Thanks for getting back so quickly. From an api perspective, a json response is perfect. Ideally I'd be able to pass parameters to filter on say last hour, day, week or whatever so that I can produce a video of "Birds heard in the last XXX" with thumbnails etc.

The heart of the livestream is a bunch of flask microservices to manage interaction with youtube chat, media creation, sequencing of view changes according to time of the day at the place etc. It should be an easy task to interact with your api and do something with the resulting data.

I have a pi or two in a drawer at home, and possibly a USB sound card, but I think i'll need to make some investments before I'd be able to listen in with any confidence.

[becausebirds]

Thank you for this! I've created the file with the code modification you mentioned to output JSON.

When I visit https://birdnet.becausebirds.com/today_count.php it just shows the contents of the file. I'm new at a lot of this, so bear with me while I'm learning :D. For my application I've been making a GET request to the BirdWeather api URL. Do I do the same thing but to the above URL?

I tried but the contents returned are the same as what I see in my browser (the raw code in the PHP file).

Thank you!!!

[ehpersonal38]

I tried but the contents returned are the same as what I see in my browser (the raw code in the PHP file).

I think this is a problem with the text editor you used to paste the contents into the file with. To make it easy just run this command and it'll download the proper version of today_count.php for you and put it in the correct directory:

wget https://gist.githubusercontent.com/ehpersonal38/a34ce000e1645bc85aba936a5f89ac72/raw/43311739c3176f1b77e298ae5fabd58afc27250b/today_count.php -O ~/BirdNET-Pi/scripts/today_count.php

For my application I've been making a GET request to the BirdWeather api URL. Do I do the same thing but to the above URL?

Yes it should be the same! You'll just have to edit the JSON key that your application looks for.

[becausebirds]

THANK YOU! Works like a charm. My sign is up and running with today's count only. So happy.

[ehpersonal38]

@becausebirds Hey I saw your Reddit post about this! Super cool to see the reach of this project, I bet Patrick would be really happy to see his work positively affecting so many people. And thank you for taking the time to share it.

[becausebirds]

I'm so happy you saw it! Reddit received it so wonderfully. So many curious and inspired people picking up the project. You were instrumental in getting me over the finish line!

BirdNET-Pi deserves as much attention as possible! I'm thrilled to have been able to create such as fun project from it! I look forward to a local API!