https://github.com/avryhof/ambient_api_postman_collection
A Postman collection for the Ambient Weather API
https://github.com/avryhof/ambient_api_postman_collection
ambientweather ambientweather-api documentation postman-collection weatherstation
Last synced: 3 months ago
JSON representation
A Postman collection for the Ambient Weather API
- Host: GitHub
- URL: https://github.com/avryhof/ambient_api_postman_collection
- Owner: avryhof
- License: mit
- Created: 2023-08-09T13:10:57.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-20T10:47:39.000Z (about 2 years ago)
- Last Synced: 2025-01-30T02:42:52.899Z (over 1 year ago)
- Topics: ambientweather, ambientweather-api, documentation, postman-collection, weatherstation
- Size: 75.2 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ambient_api_postman_collection
A [Postman](https://www.postman.com/) collection for the Ambient Weather API
```
I am not affiliated with Ambient Weather.
I am just an enthusiastic developer who loves to help out.
Some of what you see below is borrowed from the official documentation
(ex: "our servers") and I make no claim to ownership.
```
[](https://god.gw.postman.com/run-collection/13847857-862b126e-bbec-4d19-b7c0-6458c6118f55?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D13847857-862b126e-bbec-4d19-b7c0-6458c6118f55%26entityType%3Dcollection%26workspaceId%3D0a595ed9-d816-4c5b-a675-11263d0c04cb#?env%5BAmbient%20API%5D=W3sia2V5IjoidXJsIiwidmFsdWUiOiJodHRwczovL2FwaS5hbWJpZW50d2VhdGhlci5uZXQvdjEiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoiZGVmYXVsdCIsInNlc3Npb25WYWx1ZSI6Imh0dHBzOi8vYXBpLmFtYmllbnR3ZWF0aGVyLm5ldC92MSIsInNlc3Npb25JbmRleCI6MH0seyJrZXkiOiJ7e2FwaV9rZXl9fSIsInZhbHVlIjoiIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6InNlY3JldCIsInNlc3Npb25WYWx1ZSI6IiIsInNlc3Npb25JbmRleCI6MX0seyJrZXkiOiJ7e2FwcGxpY2F0aW9uX2tleX19IiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoic2VjcmV0Iiwic2Vzc2lvblZhbHVlIjoiIiwic2Vzc2lvbkluZGV4IjoyfV0=)
# Ambient Weather
##### This local documentation is a copy of [https://ambientweather.docs.apiary.io/#]() please refer to that link for the most up-to-date information.
I have omitted the connector library list. You can generate code for just about any language right from Postman.
## Authentication
Two API Keys are required for all REST API requests:
- `applicationKey` - identifies the developer / application. To create an application key please login to your
AmbientWeather.net [account page](https://ambientweather.net/account)
- `apiKey` - grants access to past/present data for a given user's devices. A typical consumer-facing application will
initially ask the user to create an `apiKey` on their
AmbientWeather.net [account page](https://ambientweather.net/account) and paste it into the app.
_Developers for personal or in-house apps will also need to create an apiKey on their own account page._
## Rate Limiting
API requests are capped at 1 request/second for each user's apiKey and 3 requests/second per applicationKey. When this
limit is exceeded, the API will return a 429 response code. Please be kind to our servers :smiley:
## Data Timing
The devices returned from the `/devices` endpoint contain a `lastData` parameter that contains the most up-to-date data
we have for the device. Most devices update every minute, some update less frequently. The timestamps are rounded to the
nearest minute.
Queries for past data using the `/devices/:macAddress`
endpoint are returned in 5 minute or 30 minute increments. There can be
up to a 10 minute delay before the most recent data becomes available.
If you need up-to-the-minute data please use the `/devices` endpoint or _forthcoming_ realtime API.
## HTTP Response Codes
(non-comprehensive list - just the ones I've seen)
| Code | Definition |
|------|------------------------------------|
| 200 | Success - You should get data back |
| 429 | Rate Limit Exceeded |
| 401 | Invalid API Key |
## Other Resources
- API Wiki - [https://github.com/ambient-weather/api-docs/wiki](https://github.com/ambient-weather/api-docs/wiki)
- Device Data Specifications: [https://github.com/ambient-weather/api-docs/wiki/Device-Data-Specs](https://github.com/ambient-weather/api-docs/wiki/Device-Data-Specs)
- My other Ambient Weather Code
- [Python Library](https://github.com/avryhof/ambient_api) - ambient_api
- [Ambient APRS Python Library](https://github.com/avryhof/ambient_aprs) - ambient_aprs
# API Functions
## GET: Devices
- https://rt.ambientweather.net/v1/devices/?apiKey={{api_key}}&applicationKey={{application_key}}
Provides a list of the user's available devices along with each device's most recent data.
#### Query Params
| Parameter | Value | Notes |
|----------------|---------------------|-----------------------------------|
| apiKey | {{api_key}} | [Authentication](#authentication) |
| applicationKey | {{application_key}} | [Authentication](#authentication) |
## GET: Device Data
- https://rt.ambientweather.net/v1/devices/{{macAddress}}?apiKey={{api_key}}&applicationKey={{application_key}}&limit=1&end_date=1691587233
Fetch data for a given device. Data is stored in 5 or 30 minute increments.
- A list of all possible fields is here: [https://github.com/ambient-weather/api-docs/wiki/Device-Data-Specs](https://github.com/ambient-weather/api-docs/wiki/Device-Data-Specs)
#### Query Params
| Parameter | Value / default | Notes |
|----------------|---------------------|-------------------------------------------------------------------------------|
| apiKey | {{api_key}} | [Authentication](#authentication) |
| applicationKey | {{application_key}} | [Authentication](#authentication) |
| limit | 1 | max = 288 |
| end_date | 1691587233 | [epoch in milliseconds](https://currentmillis.com/) (click for code samples) |
# Collection and Environment
The Postman collection can be imported directly into Postman. No alteration should be necessary.
When you import the environment, you will need to update your ApiKey, applicationKay and MAC Address.
Now you will have entries under Collections and Environments for Ambient Weather.
To use the environment, you will need to select it from the selector in the upper-right of your Postman.
# Make it code for me!
Yes, that's what I said!
[Postman](https://www.postman.com/) will generate code for you in dozens of languages.
It won't write your whole application for you, but it helps to see how it all works.
1. Choose Code Snippet from the icon bar on the right
2. Select a language from the dropdown selector
3. Bask in the presence of code that works, but you'll probably want to tweak
