Data Items

Several endpoints will be available for every Interest Type, in order to obtain specific information about the different Domains supported by Sherpa.ai Platform.

Just like the rest of the "Domain-Driven endpoints," these results will be tailored to the user, making use of the Profiling system, and prioritizing their tastes over other results.

For instance, take a user that enjoys Chinese and Japanese food. By having these food-type values linked to the user through the profiling system when invoking the /items/restaurants endpoint, the following types of results will be achieved:

Profile-prioritized restaurants
Distance-based restaurants (through the user's current geolocalization parameters)

Domain Item Endpoints

Summary of the item-specific endpoints

Domains	Endpoints
Movies	/items/movies
Restaurants	/items/restaurants
News	/items/news /items/news/categories /items/news/category/{id} /items/news/more
Weather	/items/weather
Today	/items/breakdowns
Sports
Matches	/items/sport/match
Rankings	/items/sport/soccer/ranking
Motorsports	/items/motor
Golf	/items/golf
Tennis	/items/tennis
Biking	/items/biking
Entertainment
Events	/items/nearevents
TV	/items/tv

Common Headers

Request Header	Mandatory	Description
Authorization	✓	An authentication type followed by an access token. ex: `Basic 73dbb14a-50d9-4277-897e-6cb48258d258` See Authentication section.
Sherpa-Request-Info	✓	Specific Sherpa.ai header where parameters are grouped in the form of a RequestInfo JSON object.

Common Response

For any /v2/item endpoint response, the following application/json-type syntax is expected:

{
   "criteria": {
       "pageCriteria": {
           "page": null,
           "rowsPerPage": null,
           "count": 10,
           "order": null
       },
       "lat": 37.44188,
       "lon": -122.14302,
       "type": "MOVIE",
       "propertyFilter": [
           "id"
       ]
   }, "list": [ {
       "uuid": "a41e0ff5-4a82-4cc1-a945-1aa5cd2e49b7",
       "type": "MOVIE"
  }
]

The common part of an answer will be composed of the following nodes:

criteria applied to the query in order to filter the results
- pageCriteria information for result pagination (current page, rowsPerPage and number of fetched results)
- lat/lon gathered from the RequestInfo header
- type one of the types defined in the Domain Item Endpoints table
- propertyFilter
list array with the domain-specific objects
- itemTitle main title of the item
- itemSubTitle main subtitle of the item
- itemText summary of the item
- dataId unique identifier of the item, which will be used for other endpoints
- type value will have the same value as the criteria type field most of the time, but when the item is subtyped, the value will have the second-level item categorization name and will be shown in the example

Code	Name
200	OK
400	Bad Request
401	Unauthorized
429	Too Many Requests
500	Internal Server Error
503	Service Unavailable

Domain Specific Response

In the following endpoints, we will omit the common response information to simplify the examples; we will only show one item in the response, but remember that that list will include an array of responses with multiple elements.

Movies

Basic movie information, such as title, averageRating, certification information, poster image, and theater information about where to see it, including name, address, schedule, and geolocation information.

curl -X GET "https://api.sherpa.ai/v2/items/movies" \
-H "Authorization: Basic XXXX-SHERPA-TOKEN-XXXX" \
-H "Accept-Language: en-US" \
-H "Time-Zone: Europe/Madrid" \
-H "Sherpa-Request-Info:{\"lat\":37.4418800, \"lon\":-122.1430200}"

{
    "uuid": "ea6cf949-a706-46c1-a639-9dd4293371b5",
    "type": "MOVIE",   
    "movie": {
        "title": "THE GENTLEMEN",
        "averageRating": 7.8,
        "certification": {
            "name": "R",
            "minAge": 17,
            "forChildren": false
        },
        "poster": "http://image.tmdb.org/t/p/w780/tintsaQ0WLzZsTMkTiqtMB3rfc8.jpg"        
    },
    "theater": {
        "name": "West Wind Drive-In Capitol ",
        "address": "3630 Hillcap Ave, San Jose, CA 95136, United States",
        "schedule": "[Proyeccion [extraInfo=null, fechaSesion=null, horaSesion=11:30 PM - 11:45 PM, pelicula=null]]",
        "lat": 37.2802599,
        "lon": -121.8404044
    }
}

Restaurants

Common information like name, address, categories,rating, price, urlImage, current open flag status, and information provider.

curl -X GET "https://api.sherpa.ai/v2/items/restaurants" \
-H  "Authorization: Basic XXXX-SHERPA-TOKEN-XXXX" \
-H  "accept: application/json" \
-H  "Accept-Language: en-US" \
-H  "Time-Zone: Europe/Madrid" \
-H  "Sherpa-Request-Info:{\"lat\":37.4418800, \"lon\":-122.1430200}"

 {
    "uuid": "3e86a54d-9284-4b42-abe3-046e7d61d6a2",
    "type": "RESTAURANT",    
    "itemTitle": "Pizzeria Delfina",
    "itemSubtitle": "651 Emerson St, Palo Alto 94301 Palo Alto",
    "itemText": "Pizzeria Delfina. 651 Emerson St, Palo Alto 94301 Palo Alto",   
    "name": "Pizzeria Delfina",
    "urlImage": "https://fastly.4sqi.net/img/general/720x960/61475134_zoqlw8XgadnBG-tQSgnhrRMtISjhrYaAlJqqNIbPVoc.jpg",
    "address": "651 Emerson St, Palo Alto 94301",
    "rating": "5",
    "latitude": "37.44335099534185",
    "longitude": "-122.1604892576807",
    "open": false
}

News

This is the main endpoint for gathering news.

For each returned item, the main text of the news article will be presented, along with a link to the original url from the source site, for further information. Other fields, such as date, basic clasification of news topics, and the url Image accompanying it, may also come in handy.

curl -X GET "https://api.sherpa.ai/v2/items/news" \
-H  "Authorization: Basic XXXX-SHERPA-TOKEN-XXXX" \
-H  "Accept-Language: en-US" \
-H  "Time-Zone: Europe/Madrid" \
-H  "Sherpa-Request-Info:{\"lat\":43.3017218, \"lon\":-2.9735617}"

{
      "uuid": "a23cd95c-0876-45c1-8d3b-716c968a4e29",  
      "type": "NEWS",
      "title": "Madrid and London drafting deal to preserve voting rights after Brexit",
      "text": "Spanish Foreign Ministry wants to ensure UK migrants will be able to vote and run for office in local elections next May",
      "url": "https://elpais.com/elpais/2018/12/17/inenglish/1545034701_439896.html#?ref=rss&format=simple&link=link",
      "urlImage": "https://ep00.epimg.net/politica/imagenes/2018/12/15/actualidad/1544876134_258189_1544986581_miniatura_normal.jpg",
      "date": "4 hours ago",
      "source": "elpais.com",
      "newsSource": {
        "idNewsSource": 6155,
        "description": "Feed zonal de Spain",
        "idIdioma": 1,
        "countryCode": "es",
        "url": "http://elpais.com/rss/elpais/inenglish.xml",
        "topics": [{
          "idTopic": 7,
          "nombre": "NACIONAL",
          "images": [{
            "url": "https://s3-eu-west-1.amazonaws.com/sherpa-cdn/news/defaultImages/not_land_nacional.jpg",
            "imageType": 0
          }, {
            "url": "https://s3-eu-west-1.amazonaws.com/sherpa-cdn/news/defaultImages/not_land_nacional_02.jpg",
            "imageType": 0
          }, {
            "url": "https://s3-eu-west-1.amazonaws.com/sherpa-cdn/news/defaultImages/not_port_nacional.jpg",
            "imageType": 1
          }, {
            "url": "https://s3-eu-west-1.amazonaws.com/sherpa-cdn/news/defaultImages/not_port_nacional_02.jpg",
            "imageType": 1
          }]
        }],
        "teamId": 0
      },
      "trending":false,
	  "tags":["Spain", "UK", "Brexit", "Ministry", "Elections"],      
      "topics": ["NACIONAL"]
}

News Categories

Related news categories will be returned to the user with a name and id.
This ID will be the code to be used in the /news/category/{id} endpoint.

Bear in mind that for a given user, a minimum of three categories will be returned (2090, 2091, and 2092). The rest of the categories will depend on the main interests assigned to the user.

curl -X GET "https://api.sherpa.ai/v2/items/news/categories" \
-H  "Authorization: Basic XXXX-SHERPA-TOKEN-XXXX" \
-H  "accept: application/json" \
-H  "Accept-Language: en-US" \
-H  "Time-Zone: Europe/Madrid" \
-H  "Sherpa-Request-Info:{\"lat\":43.3017218, \"lon\":-2.9735617}"

[
  {
    "name": "For you",
    "id": 2090
  }, {
    "name": "Local",
    "id": 2091
  }, {
    "name": "Trending",
    "id": 2092
  }, {
    "name": "National",
    "id": 2001
  }, {
    "name": "Technology",
    "id": 2002
  }, {
    "name": "Society and culture",
    "id": 2005
  }, {
    "name": "Science",
    "id": 20011
  }
]

News by Category ID

News endpoint specialization by category. The endpoint will be formed by the syntax /items/news/category/{id}.

As for the fetched result, it will be the same as the generic news endpoint.

The list of available categories can be fetched from /news/categories, and the first three have endpoint aliases that may come in handy.

curl -X GET "https://api.sherpa.ai/v2/items/news/category/2091" \
-H  "Authorization: Basic XXXX-SHERPA-TOKEN-XXXX" \
-H  "Accept-Language: en-US" \
-H  "Time-Zone: Europe/Madrid" \
-H  "Sherpa-Request-Info:{\"lat\":43.3017218, \"lon\":-2.9735617}"

Category Name	ID	Endpoint
Personalized	2090	/items/news /items/news/personal/ /items/news/category/2090
Local	2091	/items/news/local /items/news/category/2091
Popular	2092	/items/news/popular /items/news/category/2092

More News

All /item/news endpoints (no matter whether an alias or /category/{id}), have the possibility of fetching more items through pagination.

To do so, the suffix /more must be appended to the endpoint url. Current implementation is based on a news session, managed in server, which ensures that the endpoint serves the user with the news that is most important to them. Therefore, it is a non-parametrized pagination request.

curl -X GET "https://api.sherpa.ai/v2/items/news/local/more" \
-H  "Authorization: Basic XXXX-SHERPA-TOKEN-XXXX" \
-H  "Accept-Language: en-US" \
-H  "Time-Zone: Europe/Madrid" \
-H  "Sherpa-Request-Info:{\"lat\":43.3017218, \"lon\":-2.9735617}"

Weather

Get current weather information, as well as byDay and byHour. Give users a clothing recommendation, where each clothesUrl item will have a representative icon. Plus, provide extra information about the sunset and sunrise using solarInfo, as well as about the moonPhases.

curl -X GET "https://api.sherpa.ai/v2/items/weather" \
-H  "Authorization: Basic XXXX-SHERPA-TOKEN-XXXX" \
-H  "Accept-Language: en-US" \
-H  "Time-Zone: Europe/Madrid" \
-H  "Sherpa-Request-Info:{\"lat\":37.4418800, \"lon\":-122.1430200}"

{
    "uuid": "dbb9e8e0-e2a5-4d73-906d-3aba20d98443",
    "type": "WEATHER",
    "lat": 37.44188,
    "lon": -122.14302,
    "metric": 2,
    "current": {
        "airQualityIndex": 30,
        "city": "Palo Alto",
        "cityId": "37.44188|-122.14302",
        "country": "United States",
        "date": "3/6/2020",
        "hour": "05:08",
        "image": "https://s3-eu-west-1.amazonaws.com/sherpa-cdn/share/cache/29241495153_96cafcef1c_b.jpg",
        "latitude": 37.44189,
        "longitude": -122.143,
        "rain": 0.0,
        "rainUnit": "inch",
        "region": "California",
        "tempCurrent": 51.0,
        "tempMax": 62.0,
        "tempMin": 46.0,
        "tempUnit": "F",
        "textWeather": "Cloudy",
        "uva": 0,
        "uvaMax": 1,
        "weatherIco": 7,
        "wetness": "96%",
        "windSpeed": 5.0,
        "windSpeedUnit": "mi/h"
    },
    "byHour": [
        {
            "hour": "6AM",
            "ice": 0.0,
            "index": 1,
            "rain": 0.0,
            "rainUnit": "inch",
            "snow": 0.0,
            "temp": 50.0,
            "text": "Fog",
            "weatherIcon": 11,
            "wetness": "80",
            "windSpeed": 4.0
        },
        {
            "hour": "7AM",
            "ice": 0.0,
            "index": 2,
            "rain": 0.0,
            "rainUnit": "inch",
            "snow": 0.0,
            "temp": 50.0,
            "text": "Cloudy",
            "weatherIcon": 7,
            "wetness": "84",
            "windSpeed": 3.0
        },
        {
            "hour": "8AM",
            "ice": 0.0,
            "index": 3,
            "rain": 0.0,
            "rainUnit": "inch",
            "snow": 0.0,
            "temp": 51.0,
            "text": "Cloudy",
            "weatherIcon": 7,
            "wetness": "81",
            "windSpeed": 3.0
        },
        {
            "hour": "9AM",
            "ice": 0.0,
            "index": 4,
            "rain": 0.0,
            "rainUnit": "inch",
            "snow": 0.0,
            "temp": 53.0,
            "text": "Cloudy",
            "weatherIcon": 7,
            "wetness": "74",
            "windSpeed": 3.0
        },
        {
            "hour": "10AM",
            "ice": 0.0,
            "index": 5,
            "rain": 0.0,
            "rainUnit": "inch",
            "snow": 0.0,
            "temp": 55.0,
            "text": "Cloudy",
            "weatherIcon": 7,
            "wetness": "65",
            "windSpeed": 4.0
        },
        {
            "hour": "11AM",
            "ice": 0.0,
            "index": 6,
            "rain": 0.0,
            "rainUnit": "inch",
            "snow": 0.0,
            "temp": 59.0,
            "text": "Cloudy",
            "weatherIcon": 7,
            "wetness": "54",
            "windSpeed": 4.0
        }
    ],
    "byDay": [
        {
            "description": "Mostly cloudy",
            "tempMax": 62,
            "tempMaxNegative": false,
            "tempMaxPlural": true,
            "tempMin": 46,
            "tempMinNegative": false,
            "tempMinPlural": true,
            "uvaMax": 1,
            "weatherIcon": 6,
            "weekDay": "Friday",
            "weekDay3C": "FRI",
            "windSpeed": 5.0
        },
        {
            "description": "Cloudy and cool with a shower",
            "tempMax": 55,
            "tempMaxNegative": false,
            "tempMaxPlural": true,
            "tempMin": 35,
            "tempMinNegative": false,
            "tempMinPlural": true,
            "uvaMax": 1,
            "weatherIcon": 12,
            "weekDay": "Saturday",
            "weekDay3C": "SAT",
            "windSpeed": 5.0
        },
        {
            "description": "Mostly cloudy and cool",
            "tempMax": 55,
            "tempMaxNegative": false,
            "tempMaxPlural": true,
            "tempMin": 41,
            "tempMinNegative": false,
            "tempMinPlural": true,
            "uvaMax": 2,
            "weatherIcon": 6,
            "weekDay": "Sunday",
            "weekDay3C": "SUN",
            "windSpeed": 4.0
        },
        {
            "description": "Rain and drizzle in the p.m.",
            "tempMax": 60,
            "tempMaxNegative": false,
            "tempMaxPlural": true,
            "tempMin": 44,
            "tempMinNegative": false,
            "tempMinPlural": true,
            "uvaMax": 1,
            "weatherIcon": 12,
            "weekDay": "Monday",
            "weekDay3C": "MON",
            "windSpeed": 4.0
        },
        {
            "description": "Rain",
            "tempMax": 59,
            "tempMaxNegative": false,
            "tempMaxPlural": true,
            "tempMin": 46,
            "tempMinNegative": false,
            "tempMinPlural": true,
            "uvaMax": 1,
            "weatherIcon": 18,
            "weekDay": "Tuesday",
            "weekDay3C": "TUE",
            "windSpeed": 4.0
        }
    ],
    "solarInfo": {
        "sunSet": "6:08 PM",
        "sunRise": "6:32 AM"
    },
    "moonPhases": [
        {
            "date": "3/6/2020",
            "text": "Waxing Gibbous",
            "value": "11"
        },
        {
            "date": "3/7/2020",
            "text": "Waxing Gibbous",
            "value": "12"
        },
        {
            "date": "3/8/2020",
            "text": "Waxing Gibbous",
            "value": "13"
        },
        {
            "date": "3/9/2020",
            "text": "Full",
            "value": "14"
        },
        {
            "date": "3/10/2020",
            "text": "Waning Gibbous",
            "value": "15"
        },
        {
            "date": "3/11/2020",
            "text": "Waning Gibbous",
            "value": "16"
        },
        {
            "date": "3/12/2020",
            "text": "Waning Gibbous",
            "value": "17"
        },
        {
            "date": "3/13/2020",
            "text": "Waning Gibbous",
            "value": "18"
        },
        {
            "date": "3/14/2020",
            "text": "Waning Gibbous",
            "value": "19"
        },
        {
            "date": "3/15/2020",
            "text": "Waning Gibbous",
            "value": "20"
        },
        {
            "date": "3/16/2020",
            "text": "Last",
            "value": "21"
        },
        {
            "date": "3/17/2020",
            "text": "Last",
            "value": "21"
        },
        {
            "date": "3/18/2020",
            "text": "Waning Crescent",
            "value": "22"
        },
        {
            "date": "3/19/2020",
            "text": "Waning Crescent",
            "value": "23"
        },
        {
            "date": "3/20/2020",
            "text": "Waning Crescent",
            "value": "24"
        },
        {
            "date": "3/21/2020",
            "text": "Waning Crescent",
            "value": "25"
        },
        {
            "date": "3/22/2020",
            "text": "Waning Crescent",
            "value": "26"
        },
        {
            "date": "3/23/2020",
            "text": "Waning Crescent",
            "value": "27"
        },
        {
            "date": "3/24/2020",
            "text": "New",
            "value": "1"
        },
        {
            "date": "3/25/2020",
            "text": "New",
            "value": "1"
        },
        {
            "date": "3/26/2020",
            "text": "Waxing Crescent",
            "value": "2"
        },
        {
            "date": "3/27/2020",
            "text": "Waxing Crescent",
            "value": "3"
        },
        {
            "date": "3/28/2020",
            "text": "Waxing Crescent",
            "value": "4"
        },
        {
            "date": "3/29/2020",
            "text": "Waxing Crescent",
            "value": "5"
        },
        {
            "date": "3/30/2020",
            "text": "Waxing Crescent",
            "value": "6"
        },
        {
            "date": "3/31/2020",
            "text": "First",
            "value": "7"
        },
        {
            "date": "4/1/2020",
            "text": "First",
            "value": "7"
        },
        {
            "date": "4/2/2020",
            "text": "Waxing Gibbous",
            "value": "9"
        },
        {
            "date": "4/3/2020",
            "text": "Waxing Gibbous",
            "value": "10"
        },
        {
            "date": "4/4/2020",
            "text": "Waxing Gibbous",
            "value": "11"
        },
        {
            "date": "4/5/2020",
            "text": "Waxing Gibbous",
            "value": "12"
        },
        {
            "date": "4/6/2020",
            "text": "Waxing Gibbous",
            "value": "13"
        }
    ],   
    "clothing": {
        "backgroundUrl": "https://s3-eu-west-1.amazonaws.com/sherpa-cdn/weather/clothes/clothes-recommender-3.png",
        "clothesUrls": [
            "https://s3-eu-west-1.amazonaws.com/sherpa-cdn/weather/clothes/icon_weather_ropa_pantalon.png",
            "https://s3-eu-west-1.amazonaws.com/sherpa-cdn/weather/clothes/icon_weather_ropa_raincoat.png",
            "https://s3-eu-west-1.amazonaws.com/sherpa-cdn/weather/clothes/icon_weather_ropa_jersey.png",
            "https://s3-eu-west-1.amazonaws.com/sherpa-cdn/weather/clothes/icon_weather_ropa_bufanda.png"
        ],
        "clothingIntroText": "Recommended weather gear",
        "tempSensation": "51ºF",
        "text": "Feels like: 51ºF, UVA: 0, Palo Alto",
        "uva": "Low",
        "weatherText": "It's cold"
    }
}

Ball Sports Matches

Includes Soccer, Basketball, Baseball, and American Football matches.

curl -X GET "https://api.sherpa.ai/v2/items/sport/match" \
-H  "Authorization: Basic XXXX-SHERPA-TOKEN-XXXX"
-H  "Accept-Language: en-US" \
-H  "Time-Zone: Europe/Madrid" \
-H  "Sherpa-Request-Info:{\"lat\":37.4418800, \"lon\":-122.1430200}"

{
    "uuid": "7f03c174-cb86-4f2b-bd9d-abb5cb821cb9",
    "itemTitle": "ATH 1 - 0 GFC",
    "itemSubtitle": "Played Monday",
    "itemText": "Athletic Club 1, Girona 0.",   
    "competition": "La Liga",      
    "date": "December 10",
    "stadium": "San Mamés Barria",
    "localName": "Athletic Club",
    "localGoals": "1",
    "visitorName": "Girona"
    "visitorGoals": "0",
    "logoCompetition": "https://front-img.mod.sherpalive.com/logos/sports/futbol/liga_santander_logo.png",
    "scorers": [{
        "name": "Aduriz"
    }]
}

Ball Sports Rankings

Includes Soccer, Basketball, Baseball, and American Football rankings.

curl -X GET "https://api.sherpa.ai/v2/items/sport/soccer/ranking" \
-H  "Authorization: Basic XXXX-SHERPA-TOKEN-XXXX"
-H  "Accept-Language: en-US" \
-H  "Time-Zone: Europe/Madrid" \
-H  "Sherpa-Request-Info:{\"lat\":37.4418800, \"lon\":-122.1430200}"

{
    "uuid": "fc8c7159-cbce-4aa8-8150-23a8dbd6f781",
    "itemTitle": "La Liga Spain",
    "itemSubtitle": "Regular Season ",
    "itemText": "La Liga Spain. Regular Season ",    
    "competicionCountry": "Spain",
    "competitionName": "La Liga",
    "ranking": [{
      "teamName": "Barcelona",
      "position": 1
    }, {
      "teamName": "Sevilla",
      "position": 2
    }, {
      "teamName": "Atlético Madrid",
      "position": 3
    }, {
      "teamName": "Real Madrid",
      "position": 4
    }, {
      "teamName": "Real Betis",
      "position": 5
    }, {
      "teamName": "Deportivo Alavés",
      "position": 6
    }, {
      "teamName": "Getafe",
      "position": 7
    }, {
      "teamName": "Levante",
      "position": 8
    }, {
      "teamName": "Celta de Vigo",
      "position": 9
    }, {
      "teamName": "Girona",
      "position": 10
    }, {
      "teamName": "Espanyol",
      "position": 11
    }, {
      "teamName": "Real Valladolid",
      "position": 12
    }, {
      "teamName": "Eibar",
      "position": 13
    }, {
      "teamName": "Valencia",
      "position": 14
    }, {
      "teamName": "Real Sociedad",
      "position": 15
    }, {
      "teamName": "Leganés",
      "position": 16
    }, {
      "teamName": "Villarreal",
      "position": 17
    }, {
      "teamName": "Athletic Club",
      "position": 18
    }, {
      "teamName": "Rayo Vallecano",
      "position": 19
    }, {
      "teamName": "Huesca",
      "position": 20
    }]      
}

Motorsports

Includes subtypes F1 and MotoGP.

Get race name,status, and final classification, as well as information about practice sessions and qualifying race dates.

curl -X GET "https://api.sherpa.ai/v2/items/motor" \
-H  "Authorization: Basic XXXX-SHERPA-TOKEN-XXXX"
-H  "Accept-Language: en-US" \
-H  "Time-Zone: Europe/Madrid" \
-H  "Sherpa-Request-Info:{\"lat\":37.4418800, \"lon\":-122.1430200}"

{
    "uuid": "4b9024df-2427-442c-9f73-a757a505a099",
    "itemTitle": "Etihad Airways Abu Dhabi Grand Prix",
    "itemSubtitle": "Finished November 25",
    "itemText": "Lewis Hamilton came in first, followed by Sebastian Vettel in second, and Max Verstappen in third.",    
    "category": "F1",
    "name": "Etihad Airways Abu Dhabi Grand Prix",
    "practiceDate": "Practice: Friday, 11/23, 8:00 AM",
    "qualificationDate": "Qualification: Saturday, 11/24, 12:00 PM",
    "raceDate": "Race: Sunday, 11/25, 12:10 PM",
    "raceId": "3168",
    "status": "Played"
}

Tennis

Get information about past, future, and present tennis competitions.
Each item includes information such as competition, season , match dateTime, and player information (localPlayers and visitorPlayers). Depending on the status of the match, either the final score (scoreLocal / scoreVisitor) or the current score (partialScoreLocal / partialScoreVisitor) will be provided.
Additional information, such as the stadium or channels where the match can be seen, is also available.

curl -X GET "https://api.sherpa.ai/v2/items/tennis" \
-H  "Authorization: Basic XXXX-SHERPA-TOKEN-XXXX"
-H  "Accept-Language: en-US" \
-H  "Time-Zone: Europe/Madrid" \
-H  "Sherpa-Request-Info:{\"lat\":37.4418800, \"lon\":-122.1430200}"

{
	"uuid": "6de91d58-6775-4ab0-bb26-8d72169161fc",
    "itemTitle": "Davis Cup. World Group: Lucas Pouille,  - Marin Cilic, ",
	"itemSubtitle": "Played November 25",
	"itemText": "Copa Davis. World Group: Lucas Pouille,  - Marin Cilic, ",
	"competition": "Davis Cup. World Group",
	"competitionId": 74519,
	"competitionLogo": "http://dbp-img.mod.sherpalive.com/tenis/Davis_Cup_by_BNP_Paribas.png",
	"dateTime": 1543147200000,
	"partialScoreLocal": "6$3$3",
	"partialScoreVisitor": "7$6$6",
	"round": "Final",
	"scoreLocal": 0,
	"scoreVisitor": 3,
	"season": "2018",
	"stadium": "Stade Pierre-Mauroy",
	"status": "PLAYED",
	"localPlayers": [{
		"name": "Lucas Pouille",
		"nationalityFlagUrl": "http://dbp-img.mod.sherpalive.com/flags/png250px/fr.png",
		"photoUrl": "http://dbp-img.mod.sherpalive.com/players/tennis/3322.png",
		"countryISO": "fr"
		}],
	"visitorPlayers": [{
		"name": "Marin Cilic",
		"nationalityFlagUrl": "http://dbp-img.mod.sherpalive.com/flags/png250px/hr.png",
		"photoUrl": "http://dbp-img.mod.sherpalive.com/players/tennis/1505.png",
		"countryISO": "hr"
	}],
	"channels": [{
		"name": "Teledeporte",
		"icon": "https://s3-eu-west-1.amazonaws.com/sherpa-cdn/tv/TELEDEPORTE_texto.png"
	}]
}

Golf

Each item refers to a specific championship within the championshipTour and gathers information about the current status. When a round is finished, classification information for the first four positions will be available, including player name and thumbnail playerImage, and points in terms of tot, strks, and per round information in rounds. It also provides information about the nextRoundStart.

curl -X GET "https://api.sherpa.ai/v2/items/golf" \
-H  "Authorization: Basic XXXX-SHERPA-TOKEN-XXXX" \
-H  "Accept-Language: en-US" \
-H  "Time-Zone: Europe/Madrid" \
-H  "Sherpa-Request-Info:{\"lat\":43.3017218, \"lon\":-2.9735617}"

{
	"uuid": "822ff946-1adb-4592-87ca-c0500ff96395",
    "itemTitle": "Alfred Dunhill Championship",
	"itemSubtitle": "Played Round 1 Today, 5:20 PM",
	"itemText": "Alfred Dunhill Championship. Played Round 1 Today, 5:20 PM",
	"championship": "Alfred Dunhill Championship",
	"championshipTour": "European Tour",
	"champsionshipImage": "http://dbp-img.mod.sherpalive.com/golf/tour_2_logo.png",
	"classification": [
		{
		  "position": 1,
		  "name": "Oliver Bekker",
		  "tot": -6,
		  "strks": 66,
		  "rounds": "66$-$-$-",
		  "hole": 0,
		  "par": 0,
		  "playerImage": "http://dbp-img.mod.sherpalive.com/players/golf/687.png",
		  "playerCoupleImage": null,
		  "countryCode": "za"
		},
		{"position": 2,...  },
		{"position": 3, ... },
		{"position": 4, ... }
		],
	"nextRoundStart": 1544764800000,
	"round": "Round 1",
	"startTime": 1544678400000,
	"status": "played",
	"title": "Played",
	"tourImage": "http://dbp-img.mod.sherpalive.com/golf/tour_2_round_logo.png"
}

Biking

Biking competition information.

curl -X GET "https://api.sherpa.ai/v2/items/biking" \
-H  "Authorization: Basic XXXX-SHERPA-TOKEN-XXXX" \
-H  "Accept-Language: en-US" \
-H  "Time-Zone: Europe/Madrid" \
-H  "Sherpa-Request-Info:{\"lat\":37.4418800, \"lon\":-122.1430200}"

Events

Get information about nearby events, with details such as the name, startTime, and venue, organized by category. Additional information, such as capacity and price, is also provided.

curl -X GET "https://api.sherpa.ai/v2/items/nearevents" \
-H  "Authorization: Basic XXXX-SHERPA-TOKEN-XXXX" \
-H  "Accept-Language: en-US" \
-H  "Time-Zone: Europe/Madrid" \
-H  "Sherpa-Request-Info:{\"lat\":37.4418800, \"lon\":-122.1430200}"

{
    "uuid": "995c88a3-3f2b-453e-9ed8-3c7bb4bdef59",
    "type": "NEAR_EVENTS",   
    "name": "Fun After School Tennis Program at Addison Elem. (Gr K-5th)",
    "url": "http://sanjose.eventful.com/events/fun-after-school-tennis-pro-/E0-001-132352321-7@2020030614?utm_source=apis&utm_medium=apim&utm_campaign=apic",
    "startUTCTime": 1583534100000,
    "startLocalTime": 1583534100000,
    "endLocalTime": 1583537100000,    
    "logo": "http://d1marr3m5x4iac.cloudfront.net/images/large/I0-001/045/480/415-0.jpeg_/fun-after-school-tennis-program-addiso-15.jpeg",
    "capacity": 0,    
    "onLine": false,
    "category": {
        "id": 7,
        "name": "Sports & Fitness",
        "icon": "https://s3-eu-west-1.amazonaws.com/sherpa-cdn/icons/events/cat_eve_sports.png"
    },
    "venue": {
        "id": "V0-001-014920944-8",
        "name": "Addison Elementary",
        "fullName": "Addison Elementary - Palo Alto",
        "latitude": 37.4458985,
        "longitude": -122.150499,
        "address": {           
            "city": "Palo Alto",
            "region": "California",
            "country": "United States",
            "postalCode": "94301"
        },
        "eventAddressText": "Addison Elementary",
        "speechName": "Palo Alto"
    },      
    "organizer": {
        "id": 0,
        "name": "EuroTennis188a680"
    }
}

TV

Get TV shows based on users' tastes.

curl -X GET "https://api.sherpa.ai/v2/items/tv" \
-H  "Authorization: Basic XXXX-SHERPA-TOKEN-XXXX" \
-H  "Accept-Language: en-US" \
-H  "Time-Zone: Europe/Madrid" \
-H  "Sherpa-Request-Info:{\"lat\":37.4418800, \"lon\":-122.1430200}"

{
    "uuid": "ca73364c-4a42-45de-b737-017498c2753d",
    "type": "TV",
    "showId": "142024056",
    "title": "Mrs. Doubtfire",
    "channel": "HBO",
    "country": "US",
    "emissionCountryCode": "US",
    "idCategory": 6,
    "category": "Movies,  Comedy",
    "tags": [],  
    "year": "1993",
    "voteAverage": "7",
    "ratingStars": "7.1",
    "imageURL": "https://s3-eu-west-1.amazonaws.com/sherpa-cdn/tv/shows/142024056.png",
    "channelImageURL": "https://s3-eu-west-1.amazonaws.com/sherpa-cdn/tv/icons/c181.png",
    "categoryImageURL": "http://dbp-img.mod.sherpalive.com/apk/2016021100/images/tv/cat-cine.png",   
    "schedule": [
        {
            "from": 1583500500000,
            "to": 1583508000000,
            "episode": "",
            "fromFmt": "2:15 PM",
            "toFmt": "4:20 PM",
            "description": "A divorced dad poses as a British nanny to see his kids, and learns how to be a good parent. Meanwhile, his ex-wife's new boyfriend enters the picture."
        }
    ]
}

Breakdown

Get spoken information daily, adjusted to the user profile for every main category (news, weather, sports, entertainment, restaurants, TV, calendar, etc.), along with all the related data.

In the event that the destination is entered in the object Sherpa-Request-Info, the endpoint will return the weather at the current location and the destination.

curl -X GET "https://api.sherpa.ai/v2/items/breakdowns" \
-H  "Authorization: Basic XXXX-SHERPA-TOKEN-XXXX" \
-H  "Accept-Language: en-US" \
-H  "Time-Zone: Europe/Madrid" \
-H  "Sherpa-Request-Info:{\"lat\":43.3017218, \"lon\":-2.9735617,\"destination\":{\"lat\":40.45, \"lon\":-3.691}}"

{
    "responses": {
        "audio": "https://api.sherpa.ai/v2/query/audio/156564",
        "data": [{
                    "uuid": "18664a3c-54aa-486f-8968-eab5678b444d",
                    "type": "WEATHER",                    
                    "shareCount": "0",
                    "likeCount": "0",
                    "dislikeCount": "0",
                    "locationType": "UNKNOWN",
                    "lat": 43.3017218,
                    "lon": -2.9735617,
                    "metric": 1,
                    "current": {
                        "airQualityIndex": 30,
                        "city": "Astrabudua",
                        "cityId": "43.3017218|-2.9735617",
                        "country": "Spain",
                        "date": "9/26/2019",
                        "hour": "11:48",
                        ...,
                 },{
                    "uuid": "29b8331e-4cba-4537-885f-76c24abf5174",
                    "type": "WEATHER",     
                    "locationType": "UNKNOWN",
                    "lat": 40.45,
                    "lon": -3.691,
                    "metric": 1,
                    "current": {
                        "airQualityIndex": 25,
                        "city": "Madrid",
                        "cityId": "40.45|-3.691",
                        "country": "Spain",
                        "date": "9/26/2019",
                        "hour": "12:27",
                        ...,
                 },
                 ...
        ],
        "speech": "What's going on, Álvaro The weather is mostly cloudy ...",
        "speechCategorized": [
                   {
                       "category": "INTRODUCTION",
                       "sentences": [
                           {
                               "text": "What's going on, Álvaro?"
                           }
                       ]
                   },
                   ...
                   {
                       "category": "WEATHER",
                       "sentences": [
                           {
                               "id": "182e5390-4b6f-4a95-8203-97af3fdf6ee5",
                               "text": "The weather is mostly cloudy, and temperatures will reach between 57 and 73 degrees."
                           },
                           {
                               "id": "db528d99-1c3a-486c-a5ee-080eec34a2e7",
                               "text": "In Madrid, it's sunny, and we're expecting a high of 80 and a low of 55 degrees."
                           }
                       ]
                   },
                   ...
                   {
                       "category": "BASEBALL",
                       "sentences": [
                           {
                               "id": "0539692b-6e9d-455e-bea3-15bad1386afb",
                               "text": "In baseball, it is the first inning of Detroit Tigers game against Minnesota Twins. The score is Detroit Tigers 1, Minnesota Twins 0,"
                           },
                           {
                               "id": "393eae03-f236-402e-bafa-715e35f25284",
                               "text": "the seventh inning of Arizona Diamondbacks game against St. Louis Cardinals is in progress. The present score is Arizona Diamondbacks 9, St. Louis Cardinals 5,"
                           },
                           {
                               "id": "3cb28cbc-d7aa-46f7-843e-8ecba92682ab",
                               "text": "and it is the fourth inning of Cincinnati Reds game against Milwaukee Brewers. The score is Milwaukee Brewers 5, Cincinnati Reds 0"
                           }
                       ]
                   },
                   ...
                   {
                       "category": "RESTAURANTS",
                       "sentences": [
                           {
                               "id": "03ed8321-298d-41e2-82cc-13db47302477",
                               "text": "Want to go out for lunch? I'd suggest one of these nearby restaurants that have very good customer reviews: in Bilbao, you have Kimtxu,"
                           },
                           {
                               "id": "a7a8e154-68da-4f87-8b06-f453edb55ef4",
                               "text": "La Brasa Canalla,"
                           },
                           {
                               "id": "e60d4d98-dd53-4d84-8488-391a712179cd",
                               "text": "or Sumo"
                           }
                       ]
                   },
                   ...
                   {
                       "category": "CONCLUSION",
                       "sentences": [
                           {
                               "text": "If there's anything else you need, you can find it in Sherpa. Have a good day!"
                           }
                       ]
                   }
        ],
        "text": "What's going on, Álvaro The weather is mostly cloudy ...",
        "ssml": "<?xml version='1.0', encoding='UTF-8'?>
                 <speak xmlns='http://www.w3.org/2001/10/synthesis' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance" version="1.0" xml:lang="en" xsi:schemaLocation="http://www.w3.org/2001/10/synthesis http://www.w3.org/TR/speech-synthesis11/synthesis.xsd'>
                    <voice gender='male'>
                       <p id='INTRODUCTION'>
                            <s>What's going on, Álvaro?</s>
                       </p>
                       ...
                       <p id='WEATHER'>
                            <s id='182e5390-4b6f-4a95-8203-97af3fdf6ee5'>The weather is mostly cloudy, and temperatures will reach between 57 and 73 degrees.</s>
                            <s id='db528d99-1c3a-486c-a5ee-080eec34a2e7'>In Madrid, it's sunny, and we're expecting a high of 80 and a low of 55 degrees.</s>
                        </p>
                        ...
                        <p id='BASEBALL'>
                            <s id='0539692b-6e9d-455e-bea3-15bad1386afb'>In baseball, it is the first inning of Detroit Tigers game against Minnesota Twins. The score is Detroit Tigers 1, Minnesota Twins 0,</s>
                            <s id='393eae03-f236-402e-bafa-715e35f25284'>the seventh inning of Arizona Diamondbacks game against St. Louis Cardinals is in progress. The present score is Arizona Diamondbacks 9, St. Louis Cardinals 5,</s>
                            <s id='3cb28cbc-d7aa-46f7-843e-8ecba92682ab'>and it is the inning of Cincinnati Reds game against Milwaukee Brewers. The score is Milwaukee Brewers 5, Cincinnati Reds 0</s>
                        </p>
                        ...
                        <p id='RESTAURANTS'>
                            <s id='03ed8321-298d-41e2-82cc-13db47302477'>Want to go out for lunch? I'd suggest one of these nearby restaurants that have very good customer reviews: in Bilbao, you have Kimtxu,</s>
                            <s id='a7a8e154-68da-4f87-8b06-f453edb55ef4'>La Brasa Canalla,</s>
                            <s id='e60d4d98-dd53-4d84-8488-391a712179cd'>or Sumo</s>
                        </p>
                        ...
                        <p id='CONCLUSION'>
                            <s>If there's anything else you need, you can find it in Sherpa. Have a good day!</s>
                        </p>
                   </voice>
               </speak>"
    }
}

Each response item can have a series of optional actions to be carried out (like asking if the user wants to call someone for their birthday, let fellow meeting attendees know that they are going to be late, etc.). Response items can contain a list of contacts, whenever an optional action is triggered.

curl -X GET "https://api.sherpa.ai/v2/items/breakdowns" \
-H  "Authorization: Basic XXXX-SHERPA-TOKEN-XXXX" \
-H  "Accept-Language: en-US" \
-H  "Time-Zone: Europe/Madrid" \
-H  "Sherpa-Request-Info:{\"lat\":37.4418800, \"lon\":-122.1430200}"


```json
{
    "responses": {
        "audio": "https://api.sherpa.ai/v2/query/audio/156564",
        "data": [ {
                    "uuid": "fb5c94d9-0dca-4b2d-8052-fff8914280e8",
                    "type": "CALENDAR",                  
                    "title": "Felipe García's birthday",
                    "description": "Today is Felipe García's birthday!",
                    "start": 1569456000000,
                    "end": 1569542400000,
                    "fullDayEvent": true,
                    "birthday": true,
                    "actions": [
                        {
                            "action": "ASK_CALL_CONTACT",
                            "reason": "BIRTHDAY",
                            "data": {
                                "contacts": [
                                    {
                                        "name": "Felipe García",
                                        "phoneNumbers": [
                                            "5554334343"
                                        ],
                                        "emails": [
                                            "Felipe@sherpa.ai"
                                        ]
                                    }
                                ]
                            }
                        }
                    ],
                    "contactablePeople": [
                        {
                            "name": "Felipe García",
                            "phoneNumbers": [
                                "5554334343"
                            ],
                            "emails": [
                                "correoFelipe@sherpa.ai"
                            ]
                        }
                    ]
                   },{
                    "uuid": "c3436ce3-6f90-43b5-9eb5-9406bb8398fd",
                    "type": "CALENDAR",                    
                    "title": "Marketing Meeting",
                    "location": "Seville, Spain",
                    "latitude": "37.3890924",
                    "longitude": "-5.9844589",
                    "start": 1569506400000,
                    "end": 1569510000000,
                    "fullDayEvent": false,
                    "inTime": false,
                    "birthday": false,
                    "actions": [
                        {
                            "action": "ASK_CALL_CONTACT",
                            "reason": "LATE",
                            "data": {
                                "contacts": [
                                    {
                                        "name": "Javier",
                                        "phoneNumbers": [
                                            "555 56 56 56"
                                        ],
                                        "emails": [
                                            "correoJavier@sherpa.ai"
                                        ]
                                    }
                                ]
                            }
                        }
                    ],
                    "contactablePeople": [
                        {
                            "name": "Javier",
                            "phoneNumbers": [
                                "555 56 56 56"
                            ],
                            "emails": [
                                "correoJavier@sherpa.ai"
                            ]
                        }
                    ]
                    },
                    ...
            ],
            "speech": "Hello, Álvaro! The weather is mostly cloudy ...",
            "text":   "Hello, Álvaro! The weather is mostly cloudy ...",
            "ssml": "<?xml version='1.0', encoding='UTF-8'?>
                    <speak xmlns='http://www.w3.org/2001/10/synthesis' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance" version="1.0" xml:lang="en" xsi:schemaLocation="http://www.w3.org/2001/10/synthesis http://www.w3.org/TR/speech-synthesis11/synthesis.xsd'>
                        <voice gender='male'>
                        <p id='INTRODUCTION'>
                                <s>Hello, Álvaro!</s>
                        </p>
                        ...
                        <p id='SCHEDULE'>
                                <s id='fb5c94d9-0dca-4b2d-8052-fff8914280e8'>Here's what's on your calendar for today: Felipe García's birthday. 4 PM </s>
                                <s id='c3436ce3-6f90-43b5-9eb5-9406bb8398fd'>Marketing Meeting in Seville, Spain; you are going to be late.</s>
                        </p>
                        ...
                            <p id='CONCLUSION'>
                                <s>Have a nice afternoon!</s>
                            </p>
                    </voice>
                </speak>"
        }
}