audioBLAST! API

Recordings

This endpoint allows for the querying of recording metadata held within audioBLAST!

Data Sources

Endpoints

https://api.audioblast.org/data/recordings/

Name	Can filter?	Can autocomplete?	Description	Type	Default filter value	Allowed values
source	Y	Y	Filter by source	string
id	Y	Y	filter by id within source	string
name	Y	Y	filter by recording name	string
taxon	Y	Y	filter by recording taxon	string
filename	Y		filter by file name	string
author	Y	Y	author	string
post_date			Date the content was uploaded	string
human_size			Human readble size of file	string
bytes	Y		filter by file size	range
mime	Y	Y	MIME type of content	string
recording_type	Y	Y	Used to identify soundscape recordings	string
date			Date	string
time			Time	string
duration	Y		filter by duration	range
output	Y		The format of the returned data	string	JSON	JSON nakedJSON

https://api.audioblast.org/data/recordings/autocomplete/source/
https://api.audioblast.org/data/recordings/autocomplete/id/
https://api.audioblast.org/data/recordings/autocomplete/name/
https://api.audioblast.org/data/recordings/autocomplete/taxon/
https://api.audioblast.org/data/recordings/autocomplete/author/
https://api.audioblast.org/data/recordings/autocomplete/mime/
https://api.audioblast.org/data/recordings/autocomplete/recording_type/

Recordings-taxa

Link recordings to taxa

Data Sources

Endpoints

https://api.audioblast.org/data/recordingstaxa/

Name	Can filter?	Can autocomplete?	Description	Type	Default filter value	Allowed values
source	Y	Y	Filter by source	string
id	Y	Y	filter by id within source	string
name	Y	Y	filter by recording name	string
taxon	Y	Y	filter by recording taxon	string
filename	Y		filter by file name	string
author	Y	Y	author	string
post_date			Date the content was uploaded	string
human_size			Human readble size of file	string
bytes	Y		filter by file size	range
mime	Y	Y	MIME type of content	string
recording_type	Y	Y	Used to identify soundscape recordings	string
date			Date	string
time			Time	string
duration	Y		filter by duration	range
rank	Y	Y	Taxonomic rank	string
species	Y		Species name	string
genus	Y		Genus name	string
tribe	Y		Tribe name	string
subfamily	Y		Subfamily name	string
family	Y		Family name	string
suborder	Y		Suborder name	string
order	Y		Order name	string
class	Y		Class name	string
kingdom	Y		Kingdom name	string
output	Y		The format of the returned data	string	JSON	JSON nakedJSON

https://api.audioblast.org/data/recordingstaxa/autocomplete/source/
https://api.audioblast.org/data/recordingstaxa/autocomplete/id/
https://api.audioblast.org/data/recordingstaxa/autocomplete/name/
https://api.audioblast.org/data/recordingstaxa/autocomplete/taxon/
https://api.audioblast.org/data/recordingstaxa/autocomplete/author/
https://api.audioblast.org/data/recordingstaxa/autocomplete/mime/
https://api.audioblast.org/data/recordingstaxa/autocomplete/recording_type/
https://api.audioblast.org/data/recordingstaxa/autocomplete/rank/

Taxa

This endpoint allows for the querying of the taxonomic hierarchy held within audioBLAST!

Data Sources

BioAcoustica

Endpoints

https://api.audioblast.org/data/taxa/

Name	Can filter?	Can autocomplete?	Description	Type	Default filter value	Allowed values
taxon	Y	Y	Taxonomic name	string
rank	Y	Y	Taxonomic rank	string
species	Y		Species name	string
genus	Y		Genus name	string
tribe	Y		Tribe name	string
subfamily	Y		Subfamily name	string
family	Y		Family name	string
suborder	Y		Suborder name	string
order	Y		Order name	string
class	Y		Class name	string
kingdom	Y		Kingdom name	string
output	Y		At present just an array	string	JSON	JSON

https://api.audioblast.org/data/taxa/autocomplete/taxon/
https://api.audioblast.org/data/taxa/autocomplete/rank/

Traits

This endpoint allows for the querying of the organism traits held within audioBLAST!

Data Sources

BioAcoustica

Endpoints

https://api.audioblast.org/data/traits/

Name	Can filter?	Can autocomplete?	Description	Type	Default filter value	Allowed values
taxon	Y	Y	Taxonomic name	string
trait	Y	Y	Trait name	string
trait_ontology	Y		Link to trait in ontology	string
value	Y		Value of trait	string
call_type	Y		Type of call the trait applies to	string
sex	Y		Sex	string
temperature	Y		Temperature at which trait was measured	string
value_min	Y		Value min	string
value_max	Y		Value max	string
output	Y		At present just an array	string	JSON	JSON

https://api.audioblast.org/data/traits/autocomplete/taxon/
https://api.audioblast.org/data/traits/autocomplete/trait/

Analysis

ACI

Explain how this works...

Analysis details

ACI() function of R package seewave.

Endpoints

https://api.audioblast.org/analysis/aci/

Name	Can filter?	Description	Type	Default filter value	Allowed values
source	Y	Filter by source	string
id	Y	filter by id within source	string
startTime	Y	start time(s) to return	integer	0
value	Y	Output of analysis	integer	0
duration	Y	Analysis duration	integer	30	1 30
output	Y	At present just an array	string	JSON	JSON

Waveform analysis using audiowaveform

Explain how this works...

Endpoints

https://api.audioblast.org/analysis/audiowaveform/

Name	Can filter?	Description	Type	Default filter value	Allowed values
source	Y	Filter by source	string
id	Y	filter by id within source	string
type	Y	What type of waveform?	string		image300_40
value		Output of analysis	integer
output	Y	At present just an array	string	JSON	JSON

Rainfall analysis using the bedoya method

Explain how this works...

Analysis details

rainfallDetection(method="bedoya2017") function of R package sonicscrewdriver.

References

Bedoya et al (2017) Automatic identification of rainfall in acoustic recordings

Endpoints

https://api.audioblast.org/analysis/bedoya/

Name	Can filter?	Description	Type	Default filter value	Allowed values
source	Y	Filter by source	string
id	Y	filter by id within source	string
startTime	Y	start time(s) to return	integer	0
value	Y	Output of analysis	integer	0
output	Y	At present just an array	string	JSON	JSON

Bioacoustic index

Explain how this works...

Analysis details

bioacoustic_index() function of R package soundecology.

Endpoints

https://api.audioblast.org/analysis/bi/

Name	Can filter?	Description	Type	Default filter value	Allowed values
source	Y	Filter by source	string
id	Y	filter by id within source	string
startTime	Y	start time(s) to return	integer	0
value	Y	Output of analysis	integer	0
output	Y	At present just an array	string	JSON	JSON

Time Domain Signal Coding

Time domain signal coding is...

Analysis details

tdsc() function of R package tdsc.

Endpoints

https://api.audioblast.org/analysis/tdsc/

Name	Can filter?	Description	Type	Default filter value	Allowed values
source	Y	Filter by source	string
id	Y	filter by id within source	string
startTime	Y	start time(s) to return	integer	0
value	Y	Output of analysis	integer	0
output	Y	At present just an array	string	JSON	JSON

Standalone

Generic access to analysis information

Provide information about analyses perfomed

Endpoints

https://api.audioblast.org/standalone/analysis/fetch_analysis_counts/
Returns a count of analysis results.
Name Can filter? Can autocomplete? Description Type Default filter value Allowed values
output At present just an array string JSON JSON
source Y Filter by source string
id Y filter by id within source string
https://api.audioblast.org/standalone/analysis/list_analysis/
Returns a list of analysis types.
Name Can filter? Can autocomplete? Description Type Default filter value Allowed values
output At present just an array string JSON JSON

Name	Can filter?	Description	Type	Default filter value	Allowed values
output		At present just an array	string	JSON	JSON
source	Y	Filter by source	string
id	Y	filter by id within source	string

Name	Can filter?	Can autocomplete?	Description	Type	Default filter value	Allowed values
output			At present just an array	string	JSON	JSON

Loaded modules

Provide information about loaded modules

Endpoints

https://api.audioblast.org/standalone/modules/list_types/
Returns a list of module types.
Name Can filter? Can autocomplete? Description Type Default filter value Allowed values
output At present just an array string JSON JSON
https://api.audioblast.org/standalone/modules/list_modules/
Returns a list of modules
Name Can filter? Can autocomplete? Description Type Default filter value Allowed values
category Y Filter by module category string source
data
analysis
standalone
output At present just an array string JSON JSON
https://api.audioblast.org/standalone/modules/module_info/
Returns information about a module
Name Can filter? Can autocomplete? Description Type Default filter value Allowed values
module Y Filter by module shortname string
output At present just an array string JSON JSON
https://api.audioblast.org/standalone/modules/list_sources/
Returns a list of sources for data ingest
Name Can filter? Can autocomplete? Description Type Default filter value Allowed values
output At present just an array string JSON JSON

Name	Can filter?	Can autocomplete?	Description	Type	Default filter value	Allowed values
output			At present just an array	string	JSON	JSON

Name	Can filter?	Can autocomplete?	Description	Type	Default filter value	Allowed values
category	Y		Filter by module category	string		source data analysis standalone
output			At present just an array	string	JSON	JSON

Name	Can filter?	Can autocomplete?	Description	Type	Default filter value	Allowed values
module	Y		Filter by module shortname	string
output			At present just an array	string	JSON	JSON

Name	Can filter?	Can autocomplete?	Description	Type	Default filter value	Allowed values
output			At present just an array	string	JSON	JSON

Sun calculations

Provides information about dawn, dusk, day, night, etc.

Analysis details

daysPhases() function of R package sonicscrewdriver.

Endpoints

https://api.audioblast.org/standalone/suncalc/days_phases/
Returns day phases for a date range

Name	Can filter?	Description	Type	Default filter value	Allowed values
date	Y	String of centre date	string	today (2021-03-01)
period	Y	How long a period to retrieve	string	year	month year
lat	Y	Decimal latitude	float	50.1
lon	Y	Decimal longitude	float	1.38
tz	Y	Timezone	string	UTC
output		At present just an array	string	JSON	JSON