audioBLAST! API

Abiotic data

This endpoint allows querying abiotic measurements from deployments.

Data Sources

Urban Nature Project

Endpoints

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

Name	Can filter?	Can autocomplete?	Description	Type	Default filter value	Allowed values
source	Y	Y	Source	string
id	Y	Y	ID	string
deployment	Y		Deployment ID	string
timestamp	Y		UNIX timestamp of measurement	string
file_source	Y		File source	string
file_id	Y		File ID	string
file_relative_time	Y		Relative time in file measurement was taken	range
property	Y	Y	Measured property	string
value	Y		Measured value	string
output	Y		The format of the returned data	string	JSON	JSON nakedJSON

source starts: https://api.audioblast.org/data/abiotic/autocomplete/source/?s=[query]
source contains: https://api.audioblast.org/data/abiotic/autocomplete/source/?c=[query]
id starts: https://api.audioblast.org/data/abiotic/autocomplete/id/?s=[query]
id contains: https://api.audioblast.org/data/abiotic/autocomplete/id/?c=[query]
property starts: https://api.audioblast.org/data/abiotic/autocomplete/property/?s=[query]
property contains: https://api.audioblast.org/data/abiotic/autocomplete/property/?c=[query]

ann-o-mate

This endpoint allows for the querying of ann-o-mate.

Data Sources

Endpoints

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

Name	Can filter?	Can autocomplete?	Description	Type	Default filter value	Allowed values
source	Y	Y	Recording source	string
source_id	Y	Y	Recording ID	string
annotator	Y	Y	Annotator	string
annotation_id	Y	Y	Annotation ID	string
annotation_date	Y		Annotation date	string
annotation_info_url	Y		Annotation information link	string
recording_url	Y		Recording URL	string
time_start	Y		Start time	string
time_end	Y		End time	string
taxon	Y	Y	Taxon	string
type	Y	Y	Annotation type	string
lat	Y		Latitude	string
lon	Y		Longitude	string
contact	Y	Y	Contact	string
format			Data represenation to return.	string	internal	internal ac
output	Y		The format of the returned data	string	JSON	JSON nakedJSON tabulator

source starts: https://api.audioblast.org/data/annomate/autocomplete/source/?s=[query]
source contains: https://api.audioblast.org/data/annomate/autocomplete/source/?c=[query]
source_id starts: https://api.audioblast.org/data/annomate/autocomplete/source_id/?s=[query]
source_id contains: https://api.audioblast.org/data/annomate/autocomplete/source_id/?c=[query]
annotator starts: https://api.audioblast.org/data/annomate/autocomplete/annotator/?s=[query]
annotator contains: https://api.audioblast.org/data/annomate/autocomplete/annotator/?c=[query]
annotation_id starts: https://api.audioblast.org/data/annomate/autocomplete/annotation_id/?s=[query]
annotation_id contains: https://api.audioblast.org/data/annomate/autocomplete/annotation_id/?c=[query]
taxon starts: https://api.audioblast.org/data/annomate/autocomplete/taxon/?s=[query]
taxon contains: https://api.audioblast.org/data/annomate/autocomplete/taxon/?c=[query]
type starts: https://api.audioblast.org/data/annomate/autocomplete/type/?s=[query]
type contains: https://api.audioblast.org/data/annomate/autocomplete/type/?c=[query]
contact starts: https://api.audioblast.org/data/annomate/autocomplete/contact/?s=[query]
contact contains: https://api.audioblast.org/data/annomate/autocomplete/contact/?c=[query]

Deployment locations

This endpoint allows for listing the location of deployments.

Data Sources

Endpoints

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

Name	Can filter?	Can autocomplete?	Description	Type	Default filter value	Allowed values
source	Y	Y	Source	string
id	Y	Y	ID	string
deployment	Y		Deployment ID	string
timestamp	Y		UNIX timestamp	range
latitude	Y		Decimal latitude	range
longitude	Y		Decimal longitude	range
output	Y		The format of the returned data	string	JSON	JSON nakedJSON

source starts: https://api.audioblast.org/data/deploymentlocations/autocomplete/source/?s=[query]
source contains: https://api.audioblast.org/data/deploymentlocations/autocomplete/source/?c=[query]
id starts: https://api.audioblast.org/data/deploymentlocations/autocomplete/id/?s=[query]
id contains: https://api.audioblast.org/data/deploymentlocations/autocomplete/id/?c=[query]

Deployments

This endpoint allows for listing equipment deployments.

Data Sources

Urban Nature Project

Endpoints

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

Name	Can filter?	Can autocomplete?	Description	Type	Default filter value	Allowed values
source	Y	Y	Source	string
id	Y	Y	ID	string
name	Y	Y	Deployment name	string
device	Y	Y	Device ID	string
type	Y		Type of deployment	string		static dynamic
start	Y		Start of deployment	range
end	Y		End of deployment	range
continues_from	Y		Continues form previous deployment	string
group	Y	Y	Deployment group	string
output	Y		The format of the returned data	string	JSON	JSON nakedJSON

source starts: https://api.audioblast.org/data/deployments/autocomplete/source/?s=[query]
source contains: https://api.audioblast.org/data/deployments/autocomplete/source/?c=[query]
id starts: https://api.audioblast.org/data/deployments/autocomplete/id/?s=[query]
id contains: https://api.audioblast.org/data/deployments/autocomplete/id/?c=[query]
name starts: https://api.audioblast.org/data/deployments/autocomplete/name/?s=[query]
name contains: https://api.audioblast.org/data/deployments/autocomplete/name/?c=[query]
device starts: https://api.audioblast.org/data/deployments/autocomplete/device/?s=[query]
device contains: https://api.audioblast.org/data/deployments/autocomplete/device/?c=[query]
group starts: https://api.audioblast.org/data/deployments/autocomplete/group/?s=[query]
group contains: https://api.audioblast.org/data/deployments/autocomplete/group/?c=[query]

Devices

This endpoint allows for listing devices used in deployments.

Data Sources

Urban Nature Project

Endpoints

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

Name	Can filter?	Can autocomplete?	Description	Type	Default filter value	Allowed values
source	Y	Y	Source	string
id	Y	Y	ID	string
name	Y	Y	Device name	string
model	Y	Y	Device model	string
serial	Y	Y	Device serial number	string
hardware	Y	Y	Hardware	string
hardware_version	Y		Hardware version number	string
os	Y	Y	Operating system	string
os_version	Y		Operating system version	string
software	Y	Y	Software	string
software_version	Y		Software version number	string
firmware	Y	Y	Firmware	string
firmware_version	Y		Firmware version	string
output	Y		The format of the returned data	string	JSON	JSON nakedJSON

source starts: https://api.audioblast.org/data/devices/autocomplete/source/?s=[query]
source contains: https://api.audioblast.org/data/devices/autocomplete/source/?c=[query]
id starts: https://api.audioblast.org/data/devices/autocomplete/id/?s=[query]
id contains: https://api.audioblast.org/data/devices/autocomplete/id/?c=[query]
name starts: https://api.audioblast.org/data/devices/autocomplete/name/?s=[query]
name contains: https://api.audioblast.org/data/devices/autocomplete/name/?c=[query]
model starts: https://api.audioblast.org/data/devices/autocomplete/model/?s=[query]
model contains: https://api.audioblast.org/data/devices/autocomplete/model/?c=[query]
serial starts: https://api.audioblast.org/data/devices/autocomplete/serial/?s=[query]
serial contains: https://api.audioblast.org/data/devices/autocomplete/serial/?c=[query]
hardware starts: https://api.audioblast.org/data/devices/autocomplete/hardware/?s=[query]
hardware contains: https://api.audioblast.org/data/devices/autocomplete/hardware/?c=[query]
os starts: https://api.audioblast.org/data/devices/autocomplete/os/?s=[query]
os contains: https://api.audioblast.org/data/devices/autocomplete/os/?c=[query]
software starts: https://api.audioblast.org/data/devices/autocomplete/software/?s=[query]
software contains: https://api.audioblast.org/data/devices/autocomplete/software/?c=[query]
firmware starts: https://api.audioblast.org/data/devices/autocomplete/firmware/?s=[query]
firmware contains: https://api.audioblast.org/data/devices/autocomplete/firmware/?c=[query]

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	Source	string
id	Y	Y	ID	string
name	Y	Y	Recording name	string
taxon	Y	Y	Taxon	string
filename	Y		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		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		Duration	range
format			Data represenation to return.	string	internal	internal ac
output	Y		The format of the returned data	string	JSON	JSON nakedJSON tabulator

source starts: https://api.audioblast.org/data/recordings/autocomplete/source/?s=[query]
source contains: https://api.audioblast.org/data/recordings/autocomplete/source/?c=[query]
id starts: https://api.audioblast.org/data/recordings/autocomplete/id/?s=[query]
id contains: https://api.audioblast.org/data/recordings/autocomplete/id/?c=[query]
name starts: https://api.audioblast.org/data/recordings/autocomplete/name/?s=[query]
name contains: https://api.audioblast.org/data/recordings/autocomplete/name/?c=[query]
taxon starts: https://api.audioblast.org/data/recordings/autocomplete/taxon/?s=[query]
taxon contains: https://api.audioblast.org/data/recordings/autocomplete/taxon/?c=[query]
author starts: https://api.audioblast.org/data/recordings/autocomplete/author/?s=[query]
author contains: https://api.audioblast.org/data/recordings/autocomplete/author/?c=[query]
mime starts: https://api.audioblast.org/data/recordings/autocomplete/mime/?s=[query]
mime contains: https://api.audioblast.org/data/recordings/autocomplete/mime/?c=[query]
recording_type starts: https://api.audioblast.org/data/recordings/autocomplete/recording_type/?s=[query]
recording_type contains: https://api.audioblast.org/data/recordings/autocomplete/recording_type/?c=[query]

Recordings-Taxa

Recordings linked to taxa. This is a join between the recordings and taxa tables, primarily of use in filtering recordings by taxonomic ranks higher than species.

The autocomplete values for the taxonomic ranks are limited to those taxa matched to recordings, for more complete taxonomic autocomplete use Taxa

Data Sources

The sources used are a subset of those from Recordings.

Endpoints

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

Name	Can filter?	Can autocomplete?	Description	Type	Default filter value	Allowed values
source	Y	Y	Source	string
id	Y	Y	ID	string
name	Y	Y	Recording name	string
taxon	Y	Y	Taxon	string
filename	Y		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		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		Duration	range
rank	Y	Y	Taxonomic rank	string
species	Y	Y	Species name	string
genus	Y	Y	Genus name	string
tribe	Y	Y	Tribe name	string
subfamily	Y	Y	Subfamily name	string
family	Y	Y	Family name	string
suborder	Y	Y	Suborder name	string
order	Y	Y	Order name	string
class	Y	Y	Class name	string
kingdom	Y	Y	Kingdom name	string
output	Y		The format of the returned data	string	JSON	JSON nakedJSON

source starts: https://api.audioblast.org/data/recordingstaxa/autocomplete/source/?s=[query]
source contains: https://api.audioblast.org/data/recordingstaxa/autocomplete/source/?c=[query]
id starts: https://api.audioblast.org/data/recordingstaxa/autocomplete/id/?s=[query]
id contains: https://api.audioblast.org/data/recordingstaxa/autocomplete/id/?c=[query]
name starts: https://api.audioblast.org/data/recordingstaxa/autocomplete/name/?s=[query]
name contains: https://api.audioblast.org/data/recordingstaxa/autocomplete/name/?c=[query]
taxon starts: https://api.audioblast.org/data/recordingstaxa/autocomplete/taxon/?s=[query]
taxon contains: https://api.audioblast.org/data/recordingstaxa/autocomplete/taxon/?c=[query]
author starts: https://api.audioblast.org/data/recordingstaxa/autocomplete/author/?s=[query]
author contains: https://api.audioblast.org/data/recordingstaxa/autocomplete/author/?c=[query]
mime starts: https://api.audioblast.org/data/recordingstaxa/autocomplete/mime/?s=[query]
mime contains: https://api.audioblast.org/data/recordingstaxa/autocomplete/mime/?c=[query]
recording_type starts: https://api.audioblast.org/data/recordingstaxa/autocomplete/recording_type/?s=[query]
recording_type contains: https://api.audioblast.org/data/recordingstaxa/autocomplete/recording_type/?c=[query]
rank starts: https://api.audioblast.org/data/recordingstaxa/autocomplete/rank/?s=[query]
rank contains: https://api.audioblast.org/data/recordingstaxa/autocomplete/rank/?c=[query]
species starts: https://api.audioblast.org/data/recordingstaxa/autocomplete/species/?s=[query]
species contains: https://api.audioblast.org/data/recordingstaxa/autocomplete/species/?c=[query]
genus starts: https://api.audioblast.org/data/recordingstaxa/autocomplete/genus/?s=[query]
genus contains: https://api.audioblast.org/data/recordingstaxa/autocomplete/genus/?c=[query]
tribe starts: https://api.audioblast.org/data/recordingstaxa/autocomplete/tribe/?s=[query]
tribe contains: https://api.audioblast.org/data/recordingstaxa/autocomplete/tribe/?c=[query]
subfamily starts: https://api.audioblast.org/data/recordingstaxa/autocomplete/subfamily/?s=[query]
subfamily contains: https://api.audioblast.org/data/recordingstaxa/autocomplete/subfamily/?c=[query]
family starts: https://api.audioblast.org/data/recordingstaxa/autocomplete/family/?s=[query]
family contains: https://api.audioblast.org/data/recordingstaxa/autocomplete/family/?c=[query]
suborder starts: https://api.audioblast.org/data/recordingstaxa/autocomplete/suborder/?s=[query]
suborder contains: https://api.audioblast.org/data/recordingstaxa/autocomplete/suborder/?c=[query]
order starts: https://api.audioblast.org/data/recordingstaxa/autocomplete/order/?s=[query]
order contains: https://api.audioblast.org/data/recordingstaxa/autocomplete/order/?c=[query]
class starts: https://api.audioblast.org/data/recordingstaxa/autocomplete/class/?s=[query]
class contains: https://api.audioblast.org/data/recordingstaxa/autocomplete/class/?c=[query]
kingdom starts: https://api.audioblast.org/data/recordingstaxa/autocomplete/kingdom/?s=[query]
kingdom contains: https://api.audioblast.org/data/recordingstaxa/autocomplete/kingdom/?c=[query]

Sensors

This endpoint allows for listing sensors attached to devices.

Data Sources

Urban Nature Project

Endpoints

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

Name	Can filter?	Can autocomplete?	Description	Type	Default filter value	Allowed values
source	Y	Y	Source	string
id	Y	Y	ID	string
device	Y		Device ID	string
name	Y	Y	Sensor name	string
model	Y	Y	Sensor model	string
serial	Y		Sensor serial number	string
property	Y	Y	Property measured	string		air_temperature air_relative_humidity
output	Y		The format of the returned data	string	JSON	JSON nakedJSON

source starts: https://api.audioblast.org/data/sensors/autocomplete/source/?s=[query]
source contains: https://api.audioblast.org/data/sensors/autocomplete/source/?c=[query]
id starts: https://api.audioblast.org/data/sensors/autocomplete/id/?s=[query]
id contains: https://api.audioblast.org/data/sensors/autocomplete/id/?c=[query]
name starts: https://api.audioblast.org/data/sensors/autocomplete/name/?s=[query]
name contains: https://api.audioblast.org/data/sensors/autocomplete/name/?c=[query]
model starts: https://api.audioblast.org/data/sensors/autocomplete/model/?s=[query]
model contains: https://api.audioblast.org/data/sensors/autocomplete/model/?c=[query]
property starts: https://api.audioblast.org/data/sensors/autocomplete/property/?s=[query]
property contains: https://api.audioblast.org/data/sensors/autocomplete/property/?c=[query]

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 nakedJSON

taxon starts: https://api.audioblast.org/data/taxa/autocomplete/taxon/?s=[query]
taxon contains: https://api.audioblast.org/data/taxa/autocomplete/taxon/?c=[query]
rank starts: https://api.audioblast.org/data/taxa/autocomplete/rank/?s=[query]
rank contains: https://api.audioblast.org/data/taxa/autocomplete/rank/?c=[query]

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/list_text_values/
Returns a list of distinct text values.
Name Can filter? Can autocomplete? Description Type Default filter value Allowed values
output At present just an array string JSON JSON
taxon starts: https://api.audioblast.org/data/traits/autocomplete/taxon/?s=[query]
taxon contains: https://api.audioblast.org/data/traits/autocomplete/taxon/?c=[query]
trait starts: https://api.audioblast.org/data/traits/autocomplete/trait/?s=[query]
trait contains: https://api.audioblast.org/data/traits/autocomplete/trait/?c=[query]

Traits-Taxa

Traits linked to taxa. This is a join between the recordings and taxa tables, primarily of use in filtering recordings by taxonomic ranks higher than species.

The autocomplete values for the taxonomic ranks are limited to those taxa matched to recordings, for more complete taxonomic autocomplete use Taxa

Data Sources

The sources used are a subset of those from Recordings.

Endpoints

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

Name	Can filter?	Can autocomplete?	Description	Type	Default filter value	Allowed values
source	Y	Y	Source	string
traitID	Y	Y	Trait ID	string
taxonID	Y	Y	Taxon ID	string
taxon	Y	Y	Taxon	string
trait	Y	Y	Trait name	string
url	Y	Y	Ontology URL for trait	string
value	Y		Value	string
callType	Y	Y	Type of call	string
sex	Y	Y	Sex	string
min	Y		Minimum value	range
max	Y		Maximum value	range
rank	Y	Y	Taxonomic rank	string
species	Y	Y	Species name	string
genus	Y	Y	Genus name	string
tribe	Y	Y	Tribe name	string
subfamily	Y	Y	Subfamily name	string
family	Y	Y	Family name	string
suborder	Y	Y	Suborder name	string
order	Y	Y	Order name	string
class	Y	Y	Class name	string
kingdom	Y	Y	Kingdom name	string
output	Y		The format of the returned data	string	JSON	JSON nakedJSON

source starts: https://api.audioblast.org/data/traitstaxa/autocomplete/source/?s=[query]
source contains: https://api.audioblast.org/data/traitstaxa/autocomplete/source/?c=[query]
traitID starts: https://api.audioblast.org/data/traitstaxa/autocomplete/traitID/?s=[query]
traitID contains: https://api.audioblast.org/data/traitstaxa/autocomplete/traitID/?c=[query]
taxonID starts: https://api.audioblast.org/data/traitstaxa/autocomplete/taxonID/?s=[query]
taxonID contains: https://api.audioblast.org/data/traitstaxa/autocomplete/taxonID/?c=[query]
taxon starts: https://api.audioblast.org/data/traitstaxa/autocomplete/taxon/?s=[query]
taxon contains: https://api.audioblast.org/data/traitstaxa/autocomplete/taxon/?c=[query]
trait starts: https://api.audioblast.org/data/traitstaxa/autocomplete/trait/?s=[query]
trait contains: https://api.audioblast.org/data/traitstaxa/autocomplete/trait/?c=[query]
url starts: https://api.audioblast.org/data/traitstaxa/autocomplete/url/?s=[query]
url contains: https://api.audioblast.org/data/traitstaxa/autocomplete/url/?c=[query]
callType starts: https://api.audioblast.org/data/traitstaxa/autocomplete/callType/?s=[query]
callType contains: https://api.audioblast.org/data/traitstaxa/autocomplete/callType/?c=[query]
sex starts: https://api.audioblast.org/data/traitstaxa/autocomplete/sex/?s=[query]
sex contains: https://api.audioblast.org/data/traitstaxa/autocomplete/sex/?c=[query]
rank starts: https://api.audioblast.org/data/traitstaxa/autocomplete/rank/?s=[query]
rank contains: https://api.audioblast.org/data/traitstaxa/autocomplete/rank/?c=[query]
species starts: https://api.audioblast.org/data/traitstaxa/autocomplete/species/?s=[query]
species contains: https://api.audioblast.org/data/traitstaxa/autocomplete/species/?c=[query]
genus starts: https://api.audioblast.org/data/traitstaxa/autocomplete/genus/?s=[query]
genus contains: https://api.audioblast.org/data/traitstaxa/autocomplete/genus/?c=[query]
tribe starts: https://api.audioblast.org/data/traitstaxa/autocomplete/tribe/?s=[query]
tribe contains: https://api.audioblast.org/data/traitstaxa/autocomplete/tribe/?c=[query]
subfamily starts: https://api.audioblast.org/data/traitstaxa/autocomplete/subfamily/?s=[query]
subfamily contains: https://api.audioblast.org/data/traitstaxa/autocomplete/subfamily/?c=[query]
family starts: https://api.audioblast.org/data/traitstaxa/autocomplete/family/?s=[query]
family contains: https://api.audioblast.org/data/traitstaxa/autocomplete/family/?c=[query]
suborder starts: https://api.audioblast.org/data/traitstaxa/autocomplete/suborder/?s=[query]
suborder contains: https://api.audioblast.org/data/traitstaxa/autocomplete/suborder/?c=[query]
order starts: https://api.audioblast.org/data/traitstaxa/autocomplete/order/?s=[query]
order contains: https://api.audioblast.org/data/traitstaxa/autocomplete/order/?c=[query]
class starts: https://api.audioblast.org/data/traitstaxa/autocomplete/class/?s=[query]
class contains: https://api.audioblast.org/data/traitstaxa/autocomplete/class/?c=[query]
kingdom starts: https://api.audioblast.org/data/traitstaxa/autocomplete/kingdom/?s=[query]
kingdom contains: https://api.audioblast.org/data/traitstaxa/autocomplete/kingdom/?c=[query]

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
channel	Y	Audio channel analysed	integer	1
duration	Y	Analysis duration	integer	60	60
output	Y	At present just an array	string	JSON	JSON

Acoustic Diversity Index

Explain how this works...

Analysis details

acoustic_diversity() function of R package soundecology.

Endpoints

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

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
channel	Y	Audio channel analysed	integer	1
duration	Y	Analysis duration	integer	60	60
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
channel	Y	Audio channel analysed	integer	1
duration	Y	Analysis duration	integer	60	60
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
channel	Y	Audio channel analysed	integer	1
duration	Y	Analysis duration	integer	60	60
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

Acoustic Evenness

Explain how this works...

Analysis details

acoustic_evenness() function of R package soundecology.

Endpoints

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

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
channel	Y	Audio channel analysed	integer	1
duration	Y	Analysis duration	integer	60	60
output	Y	At present just an array	string	JSON	JSON

Acoustic Entropy

Explain how this works...

Analysis details

H() function of R package seewave.

Endpoints

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

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
channel	Y	Audio channel analysed	integer	1
duration	Y	Analysis duration	integer	60	60
output	Y	At present just an array	string	JSON	JSON

AAmplitude index

Explain how this works...

Analysis details

M() function of R package seewave.

Endpoints

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

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
channel	Y	Audio channel analysed	integer	1
duration	Y	Analysis duration	integer	60	60
output	Y	At present just an array	string	JSON	JSON

NDSI

Explain how this works...

Analysis details

NDSI() function of R package seewave.

Endpoints

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

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
channel	Y	Audio channel analysed	integer	1
duration	Y	Analysis duration	integer	60	60
output	Y	At present just an array	string	JSON	JSON

Spectral Entropy

Explain how this works...

Analysis details

sh() function of R package seewave.

Endpoints

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

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
channel	Y	Audio channel analysed	integer	1
duration	Y	Analysis duration	integer	60	60
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

Temporal Entropy

Explain how this works...

Analysis details

th() function of R package seewave.

Endpoints

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

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
channel	Y	Audio channel analysed	integer	1
duration	Y	Analysis duration	integer	60	60
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?	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
cache	Y	This query can be slow. Using the cache is highly reccommended.	boolean	1

https://api.audioblast.org/standalone/analysis/fetch_analysis_status/
Returns the status of a source in the analysis pipeline.

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
cache	Y	This query can be slow. Using the cache is highly reccommended.	boolean	1

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

Generic access to data information

Provide information about data contained in audioBlast

Endpoints

https://api.audioblast.org/standalone/data/fetch_data_counts/
Returns a count of data items.

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
cache	Y	This query can be slow. Using the cache is highly reccommended.	boolean	1

https://api.audioblast.org/standalone/data/list_data/
Returns a list of data 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/data/list_hours/
Returns total number of hours of audio in audioBlast.

Name	Can filter?	Can autocomplete?	Description	Type	Default filter value	Allowed values
cache	Y		This query can be slow. Using the cache is highly reccommended.	boolean	1
output			At present just an array	string	JSON	JSON

Embed

Allows embedding of audio files on the web.

Endpoints

https://api.audioblast.org/standalone/embed/recording/
Returns day phases for a date range

Name	Can filter?	Description	Type	Default filter value	Allowed values
source	Y	Source	string
id	Y	ID	string
title		Include title in output?	boolean	true	true false
credit		Credit audioblast.org	boolean	true	true false
output		Type of player to return.	string	html5	html5

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 embed search standalone suggests
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
https://api.audioblast.org/standalone/modules/list_embeds/
Returns a list of embed endpoints
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
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
names	Y		Array of names from lowest to highest rank	string
output			At present just an array	string	JSON	JSON

Name	Can filter?	Can autocomplete?	Description	Type	Default filter value	Allowed values
emoji	Y		An emoji of a plant or animal	string
output			At present just an array	string	JSON	JSON

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

Name	Can filter?	Description	Type	Default filter value	Allowed values
date	Y	String of centre date	string	today (2023-03-31)
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

audioBLAST! API

Data

Abiotic data

Data Sources

Endpoints

ann-o-mate

Data Sources

Endpoints

Deployment locations

Data Sources

Endpoints

Deployments

Data Sources

Endpoints

Devices

Data Sources

Endpoints

Recordings

Data Sources

Endpoints

Recordings-Taxa

Data Sources

Endpoints

Sensors

Data Sources

Endpoints

Taxa

Data Sources

Endpoints

See also

Traits

Data Sources

Endpoints

Traits-Taxa

Data Sources

Endpoints

Analysis

ACI

Analysis details

Endpoints

Acoustic Diversity Index

Analysis details

Endpoints

Waveform analysis using audiowaveform

Endpoints

Rainfall analysis using the bedoya method

Analysis details

References

Endpoints

Bioacoustic index

Analysis details

Endpoints

Acoustic Evenness

Analysis details

Endpoints

Acoustic Entropy

Analysis details

Endpoints

AAmplitude index

Analysis details

Endpoints

NDSI

Analysis details

Endpoints

Spectral Entropy

Analysis details

Endpoints

Time Domain Signal Coding

Analysis details

Endpoints

Temporal Entropy

Analysis details

Endpoints

Standalone

Generic access to analysis information

Endpoints

Generic access to data information

Endpoints

Embed

Endpoints