Get started

              API Endpoint
              https://api.soundscape.city/v1

don't forget to send an 'x-api-key' header with YOUR_API_KEY
          

The Soundscape City API provides programmatic access to fetch soundscapes by weather, location, keywords and environments

To use this API, you need an API key. Please signup at the homepage Free Signup

Every soundscape url is valid for 5min

Time Of Day


# Here is a curl example
curl \
-X GET https://api.soundscape.city/v1/time_of_day \
-H 'Content-Type: application/json' \
-d '{"time_of_day": "night"}' \
--header "x-api-key: YOUR_API_KEY"

To get a soundscape by the time of day, you need to make a GET request to the following url :
https://api.soundscape.city/v1/time_of_day



Result example :

{
  "soundscape_url": "https://ssc-tracks.s3/track.mp3",
  "time_of_day": "night"
}
                

HEADERS

Key Value
x-api-key YOUR_API_KEY

QUERY PARAMETERS

Field Type Description
time_of_day String one of the following:
  • early_morning
  • late_morning
  • noon
  • afternoon
  • evening
  • night

Weather


# Here is a curl example
curl \
-X GET https://api.soundscape.city/v1/weather \
-H 'Content-Type: application/json' \
-d '{"weather": "light_rain"}' \
--header "x-api-key: YOUR_API_KEY"

To get a soundscape by the weather, you need to make a GET request to the following url :
https://api.soundscape.city/v1/weather



Result example :

{
  "soundscape_url": "https://ssc-tracks.s3/track.mp3",
  "weather": "light_rain"
}
                

HEADERS

Key Value
x-api-key YOUR_API_KEY

QUERY PARAMETERS

Field Type Description
weather String one of the following:
  • light_rain
  • heavy_rain
  • light_wind
  • heavy_wind
  • light_thunders
  • heavy_thunders

Environment


# Here is a curl example
curl \
-X GET https://api.soundscape.city/v1/environment \
-H 'Content-Type: application/json' \
-d '{"environment": "cave"}' \
--header "x-api-key: YOUR_API_KEY"

To get a soundscape by environment, you need to make a GET request to the following url :
https://api.soundscape.city/v1/environment



Result example :

{
  "soundscape_url": "https://ssc-tracks.s3/track.mp3",
  "environment": "cave"
}
                

HEADERS

Key Value
x-api-key YOUR_API_KEY

QUERY PARAMETERS

Field Type Description
environment String one of the following:
  • apartment
  • beach
  • car
  • cave
  • city
  • coffee_shop
  • desert
  • office
  • fireplace
  • forest
  • grassland
  • jungle
  • lake
  • lobby
  • ocean
  • river
  • outer_space
  • underwater

Menu


# Here is a curl example
curl \
-X GET https://api.soundscape.city/v1/menu \
-H 'Content-Type: application/json' \
-d '{"category": "spooky"}' \
--header "x-api-key: YOUR_API_KEY"

To get a soundscape for a menu, you need to make a GET request to the following url :
https://api.soundscape.city/v1/menu



Result example :

{
  "soundscape_url": "https://ssc-tracks.s3/track.mp3",
  "category": "spooky"
}
                

HEADERS

Key Value
x-api-key YOUR_API_KEY

QUERY PARAMETERS

Field Type Description
category String one of the following:
  • spooky
  • inspirational
  • calm
  • dark