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!

Quickstart

The Search endpoint that is part of the Boone Search and Discovery API is the most frequently used API for powering travel and tourism applications. In this quick tutorial, we will walk through finding places around Orlando using the Search API.

Authentication

Requests made to the Boone API Suite must be authenticated. Instructions and examples for doing so can be found in the Authentication section. For this guide, we will be using Ruby code.

Making the search request

Our full request command is below. This example assumes that SECRET_KEY and CLIENT_ID are set already. We start with the longitude/latitude (in that order) center of the city of Orlando (-81.379234,28.538336) and go out 100km. These coordinates are something we may have picked up a mobile application or a simple geocoder. We also want to limit our search to tags including attractions, activities, art, points-of-interest and nature. A full set of available tags can be found through the API call in Standard Tags.

HMAC=`echo -n "/api/v2/search?center=-81.379234,28.538336&radius=100000&tags=attractions,activities,art,points-of-interest,nature&limit=1-" | openssl dgst -binary -sha256 -hmac $SECRET_KEY | xxd -c 256 -p`
curl -k \
-H "Content-Type: application/json" \
-H "RT-ORG-APP-CLIENT-ID: $CLIENT_ID" \
-H "RT-ORG-APP-HMAC: $HMAC" \
-X GET \
"https://api.boone.ai/api/v2/search?center=-81.379234,28.538336&radius=100000&tags=attractions,activities,art,points-of-interest,nature&limit=1"

Next is the response to that query.

{
  "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/"
      },
      "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"
        }
      ]
    },
 ],
  "meta": {
    "total": 10653
  }
}

🚧

Example Data

The data returned by your query may vary based on your individual account configuration and on the latest data available through the Boone API Suite.

Now, suppose we are interested in finding more detail about Dinosaur World. This is where we would leverage the canonical place ID, also known as the TPC (see API Concepts for more information. The canonical place ID uniquely and persistently identifies every place in the Boone dataset. We would take its canonical place ID returned, 3045724, and use that to query the Place Details endpoint. We would make the following request:

HMAC=`echo -n "/api/v2/canonical_places/3045724-" | openssl dgst -binary -sha256 -hmac $SECRET_KEY | xxd -c 256 -p`
curl -k \
-H "Content-Type: application/json" \
-H "RT-ORG-APP-CLIENT-ID: $CLIENT_ID" \
-H "RT-ORG-APP-HMAC: $HMAC" \
-X GET \
"https://api.boone.ai/api/v2/canonical_places/3045724"

Which returns the following details:

{
  "data": {
    "id": 3045724,
    "name": "Dinosaur World",
    "alt_names": [],
    "description": "Conveniently located between Orlando and Tampa, Dinosaur World in Plant City, Florida is Central Florida’s 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",
    "previous_ids": [],
    "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": "attraction",
    "contact_info": {
      "phone": "(813) 717-9865",
      "email": "[email protected]",
      "website": "http://dinosaurworld.com/florida/"
    },
    "details": {
      "credit_cards": true,
      "accessible": true,
      "restrooms": true,
      "price_rating": 2
    },
    "restaurant_details": {
      "outdoor_seating": true
    },
    "parking_details": {
      "street": false,
      "valet": false,
      "private": true,
      "garage": false,
      "rv": false,
      "free": true,
      "available": true
    },
    "engagement": {
      "rating_count": 515,
      "avg_rating": 4.0,
      "visits": null
    },
    "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"
          }
        }
      }
    ],
    "reviews": [
      {
        "text": "The set-up at Dinosaur World is truly amazing. It really captures what its like to be in a jungle. Just like in the movies of Jurassic Park. The dinosaur displays and effects were great. They were look like they are real life dinosaur! It was really fun to watch/visit with families/friends, especially for kids. There are so many things to learn and discover about dinosaurs.",
        "url": "https://roadtrippers.com/people/Sugar.19",
        "source_user": "Sugar.19",
        "comments": []
      },
      {
        "text": "As an adult, this place is fun only if you've had a few drinks. I can see my eight year old self being broken-hearted in this terrible place. I've seen more realistic looking dinosaurs at mini-golf courses. The fossil exhibit was disappointing at best. On the plus side, I did get to see a giant generic-lizard-like creature fighting a mutant of some sort. \n\nI would say you're better off going to a Natural History Museum, but Florida doesn't have a single one, which reflects the weight this state puts on science.",
        "url": "https://roadtrippers.com/people/unapologeticallyforeign",
        "source_user": "unapologeticallyforeign",
        "comments": []
      }
    ],
    "tags": [
      {
        "name": "Offbeat Attraction",
        "public_id": "offbeat-attractions"
      },
      {
        "name": "Theme Park",
        "public_id": "theme-park"
      },
      {
        "name": "Science Museum",
        "public_id": "science-museum"
      },
      {
        "name": "Children's Attraction",
        "public_id": "family"
      },
      {
        "name": "Tourist Attraction",
        "public_id": "tourist-attractions"
      },
      {
        "name": "Science Place",
        "public_id": "science"
      },
      {
        "name": "Museum",
        "public_id": "museum"
      },
      {
        "name": "Attractions & Culture",
        "public_id": "attractions"
      },
      {
        "name": "Amusement Park",
        "public_id": "amusement-parks"
      }
    ],
    "regions_hierarchy": [
      {
        "id": 6,
        "type": "regions",
        "name": "North America",
        "bounds": [
          [
            -187.652154,
            5.49857041364627
          ],
          [
            -25.0122222900391,
            83.1355025240001
          ]
        ],
        "center": [
          -100.54688,
          46.07323
        ]
      },
      {
        "id": 69,
        "type": "regions",
        "name": "United States of America",
        "bounds": [
          [
            -187.545303,
            18.913685
          ],
          [
            -66.954811,
            71.390656
          ]
        ],
        "center": [
          -98.5,
          39.76
        ]
      },
      {
        "id": 419,
        "type": "regions",
        "name": "Florida",
        "bounds": [
          [
            -87.634896,
            24.396308
          ],
          [
            -79.974306,
            31.000968
          ]
        ],
        "center": [
          -82.5001,
          28.75054
        ]
      },
      {
        "id": 1828,
        "type": "regions",
        "name": "Central Florida",
        "bounds": [
          [
            -82.85498046875,
            27.5795974731445
          ],
          [
            -80.4445266723633,
            29.427173614502
          ]
        ],
        "center": [
          -81.721388888889,
          28.926944444444
        ]
      },
      {
        "id": 6784,
        "type": "regions",
        "name": "West Central Florida",
        "bounds": [
          [
            -82.85498046875,
            27.5795974731445
          ],
          [
            -81.1310119628906,
            29.0526447296143
          ]
        ]
      },
      {
        "id": 13384,
        "type": "regions",
        "name": "Hillsborough County",
        "bounds": [
          [
            -82.7623138427734,
            27.5795974731445
          ],
          [
            -82.0542907714844,
            28.1735897064209
          ]
        ],
        "center": [
          -82.34692,
          27.90623
        ]
      }
    ]
  }
}

From this data, you can surface contact details, images, reviews, city/state, rankings and more in your application.

Updated 2 years ago

Quickstart


Suggested Edits are limited on API Reference Pages

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