b8ba5109dc
* added Recreation.gov connector * adding bootstrap * fixing tests * adding query params to not timeout on tests * fix query for tests * add recreation * run format * auto-bump connector version Co-authored-by: marcosmarxm <marcosmarxm@gmail.com> Co-authored-by: Marcos Marx <marcosmarxm@users.noreply.github.com> Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
59 lines
1.7 KiB
Markdown
59 lines
1.7 KiB
Markdown
# Recreation.gov API
|
|
|
|
## Sync overview
|
|
|
|
**Recreation Information Database - RIDB**
|
|
RIDB is a part of the Recreation One Stop (R1S) program,
|
|
which oversees the operation of Recreation.gov -- a user-friendly, web-based
|
|
resource to citizens, offering a single point of access to information about
|
|
recreational opportunities nationwide. The website represents an authoritative
|
|
source of information and services for millions of visitors to federal lands,
|
|
historic sites, museums, waterways and other activities and destinations.
|
|
|
|
This source retrieves data from the [Recreation API](https://ridb.recreation.gov/landing).
|
|
### Output schema
|
|
|
|
This source is capable of syncing the following streams:
|
|
|
|
* Activities
|
|
* Campsites
|
|
* Events
|
|
* Facilities
|
|
* Facility Addresses
|
|
* Links
|
|
* Media
|
|
* Organizations
|
|
* Permit Entrances
|
|
* Recreation Areas
|
|
* Recreation Area Addresses
|
|
* Tours
|
|
|
|
### Features
|
|
|
|
| Feature | Supported? \(Yes/No\) | Notes |
|
|
|:------------------|:----------------------|:------|
|
|
| Full Refresh Sync | Yes | |
|
|
| Incremental Sync | No | |
|
|
|
|
### Performance considerations
|
|
|
|
The Recreation API has a rate limit of 50 requests per minute.
|
|
|
|
## Getting started
|
|
|
|
### Requirements
|
|
|
|
1. A Recreation API key. You can get one by signing up [here](https://www.recreation.gov/).
|
|
2. Find your key by signing in to the API docs portal and clicking on your name in the top right corner.
|
|
|
|
### Setup guide
|
|
|
|
The following fields are required fields for the connector to work:
|
|
|
|
- `api_key`: Your Recreation API key.
|
|
|
|
## Changelog
|
|
|
|
| Version | Date | Pull Request | Subject |
|
|
|:--------|:-----------|:-------------|:-------------|
|
|
| 0.1.0 | 2022-11-02 | TBA | First Commit | |