The CityPlatform API
The engine behind CityFlow is called CityPlatform - it is a serverless backend for collecting, analyzing and organizating data, devices etc. You can use our API to get information on various users, devices and measurements in our database.
We have example language bindings in Shell, HTTP and JavaScript.
It can be accessed using your personal API token (which can be found via the Settings page on CityFlow) or you can login programatically using our API to obtain a token for further API requests.
What data can be exported using the API?
Description | Name | Unit |
Timestamp | time | - |
Average Particle Size | aPS | μm |
Battery Percentage | b | % |
device_id | device_id | - |
Relative humidity | h | %RH |
Luminosity | l | lux |
Location ID | location | - |
Mass Concentration PM1 | mP1 | μg/m3 |
Mass Concentration PM2.5 | mP2 | μg/m3 |
Mass Concentration PM4 | mP4 | μg/m3 |
Mass Concentration PM10 | mPX | μg/m3 |
Noise Average | nA | dB(A) |
Noise Max | nMa | dB(A) |
Noise Min. | nMi | dB(A) |
No. of PM1 particles | nP1 | #/cm3 |
No. of PM2.5 particles | nP2 | #/cm3 |
No. of PM4 particles | nP4 | #/cm3 |
No. of PM10 particles | nPX | #/cm3 |
Noise Standard Deviation | nS | dB(A) |
Atmospheric Pressure | p | hPa |
Rain Average | rA | mV |
Rain Max | rMa | mV |
Rain Min | rMi | mV |
Rain Standard Deviation | rS | mV |
Temperature | t | C° |
To find the API credentials
Click on 'Settings' in the top menu
Then choose the correct organization in the top of the left menu
Then click on API
You will be shown an access token that you can use to get data from the API
Where to access the API Documentation
You can access the API documentation here:
If you lack some specific endpoints or language bindings for interacting with CityPlatform - let us know and we will add it to our development roadmap and our documentation! Write to support@cityflow.live or use our live chat.