https://github.com/openaq/openaq-go
https://github.com/openaq/openaq-go
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/openaq/openaq-go
- Owner: openaq
- License: mit
- Created: 2023-01-01T19:57:50.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T16:32:03.000Z (about 1 year ago)
- Last Synced: 2025-01-11T22:45:53.815Z (4 months ago)
- Language: Go
- Size: 69.3 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# OpenAQ Golang API Client
This library is in early development. **DO NOT USE UNTIL 1.0.0 RELEASE**
A low-level golang wrapper around the OpenAQ v3 REST API.
### Usage
#### Client
A client is initialized with a configuration struct which holds some global configuration for interacting with the API.
```
client := NewClient(Config{
APIKey: "my-openaq-api-key-123456-7890"
})
```
All methods take a `context.Context` as the first parameter to allow for context level cancellation and deadlines.