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!

Attributes

Attributes are data properties used to represent observable, factual information about places of interest, which we call Canonical Places.

For some attributes, there is a finite list of acceptable values which will be accepted. Note that those are applicable both when returning information about a Canonical Place via Place Details, passing arguments to Search or Autocomplete, as well as when making suggested updates to a Canonical Place via Imports or Custom Place Data.

The Attributes API returns attributes and, when appropriate, the available values for each attribute. The response is sorted alphabetically, first by attribute and then by values (where appropriate). Attributes requires basic auth.

/api/v2/attributes

Fetch attributes and their available values for Canonical Places.

Arguments

None

Returns

A dictionary with a data property which contains an array of attributes. Each entry in the array is a separate attribute object.

Some attributes contain a values property which houses an array of objects. This array represents the exhaustive list of values allowed for that attribute. Each object possesses a name, a type, an id to be used for passing arguments to other endpoints, an optional description, and an optional depends_on property which describes the logic necessary for this attribute to be serialized in Place Details.

Response

{
  "data": {
    "details.traveler_types": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "name": "Good for traveler types",
      "description": "The types of traveler this place suits best.",
      "deprecated": #returned if being deprecated in next version,
      "depends_on": #returned if depends on another attribute to serialize,
      "api_version": #returned if a certain API version is specified
      "values": [
        {
          "name": "Adventurers",
          "id": "adventurers",
          "description": "Suitable for travelers seeking unusual and exciting places"
        },
        {
          "name": "Adrenaline junkies",
          "id": "adrenaline-junkies",
          "description": "Suitable for travelers seeking high thrill experiences"
        },
        {
          "name": "Backpackers",
          "id": "backpackers",
          "description": "Suitable for those traveling light and comfortable with basic amenities"
        },
        {
          "name": "Business travelers",
          "id": "business-travelers",
          "description": "Suitable for those traveling on business"
        },
        {
          "name": "Couples",
          "id": "couples",
          "description": "Suitable for couples seeking romantic places or experiences"
        },
        {
          "name": "Cultural travelers",
          "id": "cultural-travelers",
          "description": "Suitable for travelers seeking historic, architectural or cultural places or experiences"
        },
        {
          "name": "LGBTQ+",
          "id": "lgbtq",
          "description": "Suitable for LGBTQ+ travelers"
        },
        {
          "name": "Partiers",
          "id": "partiers",
          "description": "Suitable for those wishing to party"
        }
      ]
    },
    ...
  }
}

Updated 10 months ago

Attributes


Suggested Edits are limited on API Reference Pages

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