The Recreation Information Database (RIDB) provides data resources to citizens, offering a single point of access to information about recreational opportunities nationwide. The RIDB represents an authoritative source of information and services for millions of visitors to federal lands, historic sites, museums, and other attractions/resources. This initiative integrates multiple Federal channels and sources about recreation opportunities into a one-stop, searchable database of recreational areas nationwide.
This Python package is automatically generated by the Swagger Codegen project:
Python 2.7 and 3.4+
If the python package is hosted on Github, you can install directly from Github
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)
Then import the package:
import recdotgov_client
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install to install the package for all users)
Then import the package:
import recdotgov_client
Please follow the installation procedure and then run the following:
from __future__ import print_function
import time
import recdotgov_client
from recdotgov_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: Apikey
configuration = recdotgov_client.Configuration()
configuration.api_key['apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'
# create an instance of the API class
api_instance = recdotgov_client.ActivitiesApi(recdotgov_client.ApiClient(configuration))
query = 'query_example' # str | Query filter criteria. Searches on activity name (optional)
limit = 50 # int | Number of records to return (max 50) (optional) (default to 50)
offset = 0 # int | Start record of overall result set (optional) (default to 0)
try:
# Retrieve all activities
api_response = api_instance.get_activities(query=query, limit=limit, offset=offset)
pprint(api_response)
except ApiException as e:
print("Exception when calling ActivitiesApi->get_activities: %s\n" % e)
# Configure API key authorization: Apikey
configuration = recdotgov_client.Configuration()
configuration.api_key['apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'
# create an instance of the API class
api_instance = recdotgov_client.ActivitiesApi(recdotgov_client.ApiClient(configuration))
activity_id = 'activity_id_example' # str | Id of the activity
try:
# Retrieve a specific activity by id
api_response = api_instance.get_activity(activity_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ActivitiesApi->get_activity: %s\n" % e)
# Configure API key authorization: Apikey
configuration = recdotgov_client.Configuration()
configuration.api_key['apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'
# create an instance of the API class
api_instance = recdotgov_client.ActivitiesApi(recdotgov_client.ApiClient(configuration))
facility_id = 'facility_id_example' # str | Id of the facility
query = 'query_example' # str | Query filter criteria. Searches on activity name (optional)
limit = 50 # int | Number of records to return (max 50) (optional) (default to 50)
offset = 0 # int | Start record of overall result set (optional) (default to 0)
try:
# Retrieve all activities for a facility
api_response = api_instance.get_facility_activities(facility_id, query=query, limit=limit, offset=offset)
pprint(api_response)
except ApiException as e:
print("Exception when calling ActivitiesApi->get_facility_activities: %s\n" % e)
# Configure API key authorization: Apikey
configuration = recdotgov_client.Configuration()
configuration.api_key['apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'
# create an instance of the API class
api_instance = recdotgov_client.ActivitiesApi(recdotgov_client.ApiClient(configuration))
facility_id = 'facility_id_example' # str | Id of the facility
activity_id = 'activity_id_example' # str | Id of the activity
try:
# Retrieve a specific activity by id for a facility
api_response = api_instance.get_facility_activity(facility_id, activity_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ActivitiesApi->get_facility_activity: %s\n" % e)
# Configure API key authorization: Apikey
configuration = recdotgov_client.Configuration()
configuration.api_key['apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'
# create an instance of the API class
api_instance = recdotgov_client.ActivitiesApi(recdotgov_client.ApiClient(configuration))
rec_area_id = 'rec_area_id_example' # str | Id of the RecArea
query = 'query_example' # str | Query filter criteria. Searches on activity name (optional)
limit = 50 # int | Number of records to return (max 50) (optional) (default to 50)
offset = 0 # int | Start record of overall result set (optional) (default to 0)
try:
# Retrieve all activities for a RecArea
api_response = api_instance.get_rec_area_activities(rec_area_id, query=query, limit=limit, offset=offset)
pprint(api_response)
except ApiException as e:
print("Exception when calling ActivitiesApi->get_rec_area_activities: %s\n" % e)
# Configure API key authorization: Apikey
configuration = recdotgov_client.Configuration()
configuration.api_key['apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'
# create an instance of the API class
api_instance = recdotgov_client.ActivitiesApi(recdotgov_client.ApiClient(configuration))
rec_area_id = 'rec_area_id_example' # str | Id of the RecArea
activity_id = 'activity_id_example' # str | Id of the activity
try:
# Retrieve a specific activity by id for a RecArea
api_response = api_instance.get_rec_area_activity(rec_area_id, activity_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ActivitiesApi->get_rec_area_activity: %s\n" % e)
All URIs are relative to https://ridb.recreation.gov/api/v1
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ActivitiesApi | get_activities | GET /activities | Retrieve all activities |
| ActivitiesApi | get_activity | GET /activities/{activityId} | Retrieve a specific activity by id |
| ActivitiesApi | get_facility_activities | GET /facilities/{facilityId}/activities | Retrieve all activities for a facility |
| ActivitiesApi | get_facility_activity | GET /facilities/{facilityId}/activities/{activityId} | Retrieve a specific activity by id for a facility |
| ActivitiesApi | get_rec_area_activities | GET /recareas/{recAreaId}/activities | Retrieve all activities for a RecArea |
| ActivitiesApi | get_rec_area_activity | GET /recareas/{recAreaId}/activities/{activityId} | Retrieve a specific activity by id for a RecArea |
| AttributesApi | get_campsite_attributes | GET /campsites/{campsiteId}/attributes | Retrieve all attributes for a campsite |
| AttributesApi | get_permit_entrance_attributes | GET /permitentrances/{permitEntranceId}/attributes | Retrieve all attributes for a permit entrance |
| AttributesApi | get_tour_attributes | GET /tours/{tourId}/attributes | Retrieve all attributes for a tour |
| CampsitesApi | get_campsite | GET /campsites/{campsiteId} | Retrieve a specific campsite by id |
| CampsitesApi | get_campsites | GET /campsites | Retrieve all campsites |
| CampsitesApi | get_facility_campsite | GET /facilities/{facilityId}/campsites/{campsiteId} | Retrieve a specific campsite by id for a facility |
| CampsitesApi | get_facility_campsites | GET /facilities/{facilityId}/campsites | Retrieve all campsites for a facility |
| EventsApi | get_event | GET /events/{eventId} | Retrieve a specific event by id |
| EventsApi | get_events | GET /events | Retrieve all events |
| EventsApi | get_facility_event | GET /facilities/{facilityId}/events/{eventId} | Retrieve a specific event by id for a facility |
| EventsApi | get_facility_events | GET /facilities/{facilityId}/events | Retrieve all events for a facility |
| EventsApi | get_rec_area_event | GET /recareas/{recAreaId}/events/{eventId} | Retrieve a specific event by id for a RecArea |
| EventsApi | get_rec_area_events | GET /recareas/{recAreaId}/events | Retrieve all events for a RecArea |
| FacilitiesApi | get_facilities | GET /facilities | Retrieve all facilities |
| FacilitiesApi | get_facility | GET /facilities/{facilityId} | Retrieve a specific facility by id |
| FacilitiesApi | get_organization_facilities | GET /organizations/{orgId}/facilities | Retrieve all facilities for an organization |
| FacilitiesApi | get_organization_facility | GET /organizations/{orgId}/facilities/{facilityId} | Retrieve a specific facility by id for an organization |
| FacilitiesApi | get_rec_area_facilities | GET /recareas/{recAreaId}/facilities | Retrieve all facilities for a RecArea |
| FacilitiesApi | get_rec_area_facility | GET /recareas/{recAreaId}/facilities/{facilityId} | Retrieve a specific facility by id for a RecArea |
| FacilityAddressesApi | get_facility_address | GET /facilityaddresses/{facilityAddressId} | Retrieve a specific facility address by id |
| FacilityAddressesApi | get_facility_addresses | GET /facilityaddresses | Retrieve all facility addresses |
| FacilityAddressesApi | get_facility_facility_address | GET /facilities/{facilityId}/facilityaddresses/{facilityAddressId} | Retrieve a specific facility address by id for a facility |
| FacilityAddressesApi | get_facility_facility_addresses | GET /facilities/{facilityId}/facilityaddresses | Retrieve all facility addresses for a facility |
| LinksApi | get_facility_link | GET /facilities/{facilityId}/links/{linkId} | Retrieve a specific link by id for a facility |
| LinksApi | get_facility_links | GET /facilities/{facilityId}/links | Retrieve all links for a facility |
| LinksApi | get_link | GET /links/{linkId} | Retrieve a specific link by id |
| LinksApi | get_links | GET /links | Retrieve all links |
| LinksApi | get_rec_area_link | GET /recareas/{recAreaId}/links/{linkId} | Retrieve a specific link by id for a RecArea |
| LinksApi | get_rec_area_links | GET /recareas/{recAreaId}/links | Retrieve all links for a RecArea |
| MediaApi | get_all_facility_media | GET /facilities/{facilityId}/media | Retrieve all media for a facility |
| MediaApi | get_all_media | GET /media | Retrieve all media |
| MediaApi | get_all_rec_area_media | GET /recareas/{recAreaId}/media | Retrieve all media for a RecArea |
| MediaApi | get_facility_media | GET /facilities/{facilityId}/media/{mediaId} | Retrieve a specific media by id for a facility |
| MediaApi | get_media | GET /media/{mediaId} | Retrieve a specific media by id |
| MediaApi | get_rec_area_media | GET /recareas/{recAreaId}/media/{mediaId} | Retrieve a specific media by id for a RecArea |
| OrganizationsApi | get_organization | GET /organizations/{orgId} | Retrieve a specific organization by id |
| OrganizationsApi | get_organizations | GET /organizations | Retrieve all organizations |
| PermitEntrancesApi | get_facility_permit_entrance | GET /facilities/{facilityId}/permitentrances/{permitEntranceId} | Retrieve a specific permit entrance by id for a facility |
| PermitEntrancesApi | get_facility_permit_entrances | GET /facilities/{facilityId}/permitentrances | Retrieve all permit entrances for a facility |
| PermitEntrancesApi | get_permit_entrance | GET /permitentrances/{permitentranceId} | Retrieve a specific permit entrance by id |
| PermitEntrancesApi | get_permit_entrances | GET /permitentrances | Retrieve all permit entrances |
| RecreationAreaAddressesApi | get_rec_area_address | GET /recareaaddresses/{recAreaAddressId} | Retrieve a specific RecArea address by id |
| RecreationAreaAddressesApi | get_rec_area_addresses | GET /recareaaddresses | Retrieve all RecArea addresses |
| RecreationAreaAddressesApi | get_rec_area_rec_area_address | GET /recareas/{recAreaId}/recareaaddresses/{recAreaAddressId} | Retrieve a specific RecArea address by id for a RecArea |
| RecreationAreaAddressesApi | get_rec_area_rec_area_addresses | GET /recareas/{recAreaId}/recareaaddresses | Retrieve all RecArea addresses for a RecArea |
| RecreationAreasApi | get_organization_rec_area | GET /organizations/{orgId}/recareas/{recAreaId} | Retrieve a specific RecArea by id for an organization |
| RecreationAreasApi | get_organization_rec_areas | GET /organizations/{orgId}/recareas | Retrieve all RecAreas for an organization |
| RecreationAreasApi | get_rec_area | GET /recareas/{recAreaId} | Retrieve a specific RecArea by id |
| RecreationAreasApi | get_rec_areas | GET /recareas | Retrieve all RecAreas |
| ToursApi | get_facility_tour | GET /facilities/{facilityId}/tours/{tourId} | Retrieve a specific tour by id for a facility |
| ToursApi | get_facility_tours | GET /facilities/{facilityId}/tours | Retrieve all tours for a facility |
| ToursApi | get_tour | GET /tours/{tourId} | Retrieve a specific tour by id |
| ToursApi | get_tours | GET /tours | Retrieve all tours |
| ZonesApi | get_permit_entrance_zone | GET /permitentrances/{permitEntranceId}/zones/{zoneId} | Retrieve a zone for a permit entrance |
| ZonesApi | get_permit_entrance_zones | GET /permitentrances/{permitEntranceId}/zones | Retrieve all zones for a permit entrance |