Byway Data Export

Requirements

  1. Register for a National Scenic Byways website account if you don't have one - you will need to identify yourself with your account information each time you perform a data export.

  2. Data is provided in XML format for easy machine readability. Some pieces of information may include embedded HTML tags.

  3. Referenced images will include a URL - please retrieve your own copy of the image rather than linking directly to our sites.

Requesting Byway Data

Use the following base URL to access our byway data export service:

http://bywaysonline.org/export/V1/byways?

Request Parameters

By default, the service will retrieve core data for all byways. Use the following URL parameters to customize your request:

Parameter Value Description
state string[,string]... Comma-separated list of two-letter postal abbreviations for U.S. States. This will restrict the resulting list of byways to the specified States. This may be combined with the group and byway parameters for additional filtering.
group string

One of the following values, to restrict the result to byways falling into one of these groups:

  • ab - America's Byways
  • usfs - National Forest Scenic Byways
  • blm - BLM Back Country Byways

This may be combined with the state and byway parameters for additional filtering.
byway integer[,integer]... Comma-separated list of byway IDs, to retrieve only the specified byways. A byway's ID can be found in the URL of its page, or in the ID element of exported data. This may be combined with the group and state parameters for additional filtering.
include string[,string]...

Comma-separated list of values from the following list, to include optional data in the result set:

  • all - Include all of the following:
  • activities - Featured activities to experience along the byway
  • directions - Directions for getting to the byway and navigating its route
  • maps - Maps of the byway
  • places - List of places to visit
  • route - GIS data for the byway route, in GML format
  • services - Available visitor services and travel restrictions
  • websites - Related websites

Constructing a Request URL

Requests should use GET and start with the base URL for the desired service, for example:

http://bywaysonline.org/export/V1/byways?

Request parameters are added to the end of the base URL and are in the form parameter=value. Multiple parameters are separated by an ampersand (&). For example:

http://bywaysonline.org/export/V1/byways?state=IL&group=ab

Getting Help

Please direct any comments, problems, or technical issues with the Data Export API to the website design team at helpdesk@byways.org.