Roadtrippers Developer Hub

Welcome to the Roadtrippers Developer Hub. You'll find comprehensive guides and documentation to help you start working with Roadtrippers as quickly as possible, as well as support if you get stuck. Let's jump right in!

Search

The Search endpoint powers discovery of the most interesting travel and tourism places. It takes a coordinate center and a search radius, as well as a list of optional tags (see Standard Tags to pull a currently available list) and returns a list of relevant places. The results can be ranked by distance or by Boone's TravelRank technology (see API Concepts for more information).

Search requires basic auth.

/api/v2/search

Filter parameters

Name

Type

Description

center

string in LONGITUDE,LATITUDE format (two floats)

Latitude: Greater than -90, less than 90
Longitude: Greater than -180, less than 180

Note: Each result will include a distance property with the distance in meters from the center when specified.

radius

integer

Positive nonzero number. Meters from center point described by latitude, longitude pair.

tags

string (comma separated list) Prefix with ! to exclude tag.

Optional. Comma separated list of canonical tag public ids to search for or to exclude (e.g., points-of-interest,sports,attractions. Tags can be found via the tags endpoint .

name

string

Optional. Filters on matching names and alt_names.

locations

string (| separated list)

| separated of list of country codes country:US and region_ids region_id:6
See country codes and Regions reference.

For example, country:CA|country:MX|country:US would limit a search to North America.

region_id:1883|region_id:1852 would limit a search to results in Ohio (1883) or Kentucky (1852)

Locations filter will take precedence over other bounds.

This is an experimental feature

chains

string (comma separated list) Prefix with ! to exclude chain.

Optional. Comma separated list of chain public ids to search for or to exclude (e.g., walmart). Chains can be found via the Chains API.

cultural_query

string

Coming soon. Optional. A text search query for finding relevant places, in the search radius. As an example, searching for "Elvis Presley" in Memphis to find "Sun Studios"

min_fidelity

integer (1-5)

Optional. Filters on matching fidelity_level equal to or above the given value.
Cannot exceed max_fidelity

max_fidelity

integer (1-5)

Optional. Filters on matching fidelity_level equal to or lower than the given value.

rv_service_serviced_makes

array of strings

Optional. Filters on the makes serviced by the RV service provider. Choose from the list provided by /api/v2/rvs/makes.

rv_service_serviced_rv_types

array of strings

Optional. Filter on RV types serviced by the RV service provider. Choose from the list provided by /api/v2/rvs/types.

rv_service_available_services

string

Optional. Filter on services provided by the RV service provider. Choose from the list provided by /api/v2/rvs/services or search by keyword.

rv_service_dealer_amenities

string

Optional. Filter on amenities available at the RV service provider. Search by keyword.

rv_service_rental_available

bool

Optional. Filter based on whether the RV service provider has rental RVs available.

rv_service_rvda_member

bool

Optional. Filter based on whether the RV service provider is a member of RVDA.

rv_service_five_rivets_dealer

bool

Optional. Filter based on whether the RV service provider is a 5 Rivets dealer.

Bounding box parameters

Restrict results to a bounding box defined by north and south latitude and east and west longitude values. All four values are required.

Combined with the center and radius, the results will be limited to the intersection of the bounding box and the radius around the center. This is useful for limiting based on screen size and visibility.

Name

Type

Description

north

float

Northern latitude,
Greater than -90, less than 90

south

float

Southern latitude,
Greater than -90, less than 90

east

float

Eastern longitude
Greater than -180, less than 180

west

float

Western longitude
Greater than -180, less than 180

Paging parameters

Name

Type

Description

limit

integer

Optional. Default 10. Greater than 0. Maximum number of results to return in call.

offset

integer

Optional. Default 0. Greater than or equal to 0. Starting index/page for returning limit search results. 0 is the first page.

Sort parameters

Name

Type

Description

sort

string

Optional. Default behavior is to sort by ranking.score descending.
Sort options can be specified in a , separated string with optional +/- for ascending/descending before ranking.score, distance, name, or last_updated.

For example,
+name,ranking.score would sort first on name ascending, then ranking.score descending.

The default direction for each option are as follows:
ranking.score = descending
name = ascending
distance = ascending
last_updated = descending

Example Query

{"center":"-84.4194,39.117306","radius":10000,"tags":"points-of-interest,sports,attractions"}

Returns

Status: 200

Example Result

{
  "data": [
    {
      "id": 3045724,
      "name": "Dinosaur World",
      "alt_names": [],
      "description": "Conveniently located between Orlando and Tampa, Dinosaur World in Plant City, Florida is Central Florida\u2019s only attraction dedicated to the giants of years past.\n\nWith over 20-acres to explore, you will find yourself wandering amongst some of the most feared predators ever to walk the planet. Dinosaur World offers a unique, natural setting featuring a lush garden setting and paved walkways where you will encounter a wide variety of dinosaurs representing many diverse and unusual species.",
      "subtitle": "the worlds largest dinosaur attraction",
      "hours": {
        "<default>": {
          "sun_open_close": [
            "09:00-17:00"
          ],
          "mon_open_close": [
            "09:00-17:00"
          ],
          "tue_open_close": [
            "09:00-17:00"
          ],
          "wed_open_close": [
            "09:00-17:00"
          ],
          "thu_open_close": [
            "09:00-17:00"
          ],
          "fri_open_close": [
            "09:00-17:00"
          ],
          "sat_open_close": [
            "09:00-17:00"
          ]
        }
      },
      "icon": "monument",
      "contact_info": {
        "phone": "(813) 717-9865",
        "email": "[email protected]",
        "website": "http:\/\/dinosaurworld.com\/florida\/"
      },
      "road_trip_details": {
        "map_markers": [ 
          "iconic attraction"
        ],
        "map_illustration": "<svg width=\"28\" height=\"28\" xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\">\n  <defs>\n    <path d=\"M16.25 5c-3.04695 0-5.61915 2.018475-6.4593 4.7907C7.0187 10.630175 5 13.20305 5 16.25 5 19.9787 8.021975 23 11.75 23c3.04695 0 5.61915-2.0187 6.4593-4.7907C20.9813 17.37005 23 14.79695 23 11.75 23 8.0213 19.9787 5 16.25 5zm-4.5 16.499925c-2.8944 0-5.249925-2.355525-5.249925-5.249925 0-2.0961 1.237725-3.90465 3.01815-4.74525C9.5153 11.587325 9.5 11.666525 9.5 11.75c0 3.7287 3.021975 6.75 6.75 6.75.083475 0 .162675-.0153.245475-.018225-.8415 1.780425-2.649375 3.01815-4.745475 3.01815zm6.731775-5.00445c.002925-.0828.018225-.162.018225-.245475 0-3.7287-3.021975-6.75-6.75-6.75-.083475 0-.162675.0153-.244575.01845.8406-1.78065 2.648475-3.018375 4.744575-3.018375 2.8944 0 5.249925 2.35485 5.249925 5.249925 0 2.0961-1.237725 3.903975-3.01815 4.745475z\" id=\"a\"></path>\n  </defs>\n  \n</svg>",
        "editorial": "Dinosaur World's unique, natural setting makes exploring the amazing prehistoric giants a beautiful adventure.",
        "magazine_articles": [
          "https://roadtrippers.com/magazine/abandoned-ghost-town-smoky-mountains/"
        ],
        "trip_guides": [
          "https://maps.roadtrippers.com/trips/10388079"
        ],
        "contributor": "https://maps.roadtrippers.com/people/amhider"
        },
      "details": {
        "credit_cards": true,
        "accessible": true,
        "restrooms": true,
        "price_rating": 2
      },
      "parking_details": {
        "street": false,
        "valet": false,
        "private": true,
        "garage": false,
        "rv": false,
        "free": true,
        "available": true
      },
      "engagement": {
        "rating_count": 515,
        "avg_rating": 4
      },
      "locations": [
        {
          "address1": "5145 Harvey Tew Road",
          "postal_code": "33565",
          "city": "Plant City",
          "state": "FL",
          "country": "USA",
          "latitude": 28.028732,
          "longitude": -82.189485
        }
      ],
      "images": [
        {
          "image_url": "https:\/\/atlas-assets.roadtrippers.com\/uploads\/place_image\/image\/16956774\/place_image-image-fa20458f-fcda-41d5-876c-5b48faf52304.jpg",
          "fingerprint": "d1c42ac113bc248d80291276746b3998",
          "enabled": true,
          "sizes": {
            "thumbnail": {
              "width": 150,
              "height": 150,
              "url": "https:\/\/atlas-assets.roadtrippers.com\/uploads\/place_image\/image\/16956774\/-strip_-quality_60_-interlace_Plane_-resize_150x150_U__-gravity_center_-extent_150x150\/place_image-image-fa20458f-fcda-41d5-876c-5b48faf52304.jpg"
            },
            "square": {
              "width": 320,
              "height": 320,
              "url": "https:\/\/atlas-assets.roadtrippers.com\/uploads\/place_image\/image\/16956774\/-strip_-quality_60_-interlace_Plane_-resize_320x320_U__-gravity_center_-extent_320x320\/place_image-image-fa20458f-fcda-41d5-876c-5b48faf52304.jpg"
            },
            "small": {
              "width": 320,
              "height": 240,
              "url": "https:\/\/atlas-assets.roadtrippers.com\/uploads\/place_image\/image\/16956774\/-strip_-quality_60_-interlace_Plane_-resize_320x240_U__-gravity_center_-extent_320x240\/place_image-image-fa20458f-fcda-41d5-876c-5b48faf52304.jpg"
            },
            "medium": {
              "width": 800,
              "height": 600,
              "url": "https:\/\/atlas-assets.roadtrippers.com\/uploads\/place_image\/image\/16956774\/-strip_-quality_60_-interlace_Plane_-resize_800x600_U__-gravity_center_-extent_800x600\/place_image-image-fa20458f-fcda-41d5-876c-5b48faf52304.jpg"
            },
            "large": {
              "width": 1024,
              "height": 768,
              "url": "https:\/\/atlas-assets.roadtrippers.com\/uploads\/place_image\/image\/16956774\/-strip_-quality_60_-interlace_Plane_-resize_1024x768_U__-gravity_center_-extent_1024x768\/place_image-image-fa20458f-fcda-41d5-876c-5b48faf52304.jpg"
            }
          }
        }
      ],
      "tags": [
        {
          "name": "Science Place",
          "public_id": "science"
        },
        {
          "name": "Offbeat Attraction",
          "public_id": "offbeat-attractions"
        },
        {
          "name": "Tourist Attraction",
          "public_id": "tourist-attractions"
        },
        {
          "name": "Children's Attraction",
          "public_id": "family"
        },
        {
          "name": "Science Museum",
          "public_id": "science-museum"
        },
        {
          "name": "Theme Park",
          "public_id": "theme-park"
        },
        {
          "name": "Museum",
          "public_id": "museum"
        },
        {
          "name": "Attractions & Culture",
          "public_id": "attractions"
        },
        {
          "name": "Amusement Park",
          "public_id": "amusement-parks"
        }
      ],
      "temporary_closures": [
        {
         "id": 123,
         "start_date": "2019-07-04",
         "end_date": "2019-07-05",
         "reason": "holiday"
        },
        {
          "id": 124,
          "start_date": "2019-09-02",
          "end_date": "2019-09-02",
          "reason": "holiday"
        }
       ],
      "status": {
        "operating_normally": false,
        "reason": "holiday",
        "changes_at": "2019-07-05"
      },
      "distance": 4392.12323433
    },
 ],
  "meta": {
    "total": 10653
  }
}

Updated 11 months ago

Search


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.