Trends

Returns the places X offers trends for. Pass a location's woeid to /x/trends. Each returned location costs 1 credit.

get/api/v1/x/trends/locations

Request

  • Base URL: https://xquik.com
  • URL: https://xquik.com/api/v1/x/trends/locations
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer
    • none

Query parameters

countrystring

Country name or 2-letter code, such as Turkey or TR. Case insensitive. Returns the country & its towns. X can add places, so Xquik takes up to 280 characters, the most a post holds.

placeType'country' | 'town' | 'worldwide' | 'unknown'

Kind of place. Case insensitive. X labels a few towns unknown.

qstring

Text the location name contains, such as york. Case insensitive. Alias query. X can add places, so Xquik takes up to 280 characters, the most a post holds.

limitinteger

Maximum locations to return. Omit it for every match. A low credit balance can return fewer. Aliases pageSize, count, max_results, maxItems, max_items & per_page.

fieldsstring
Example:id,text,author.username

Fields to keep in each row, comma-separated. Use dots for nested fields, such as author.username. A list keeps the field in each item. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name answers 400 unknown_field with the valid names, before any read. The price stays the same. SDK row types then hold only the named fields. A longer URL fails at the edge before Xquik reads it.

omitstring
Example:entities,media

Fields to drop from each row, comma-separated. It takes the same names as fields. With fields, it drops from the kept fields. A longer URL fails at the edge before Xquik reads it.

Response

Locations X offers trends for

countinteger required

Locations returned & charged.

totalinteger required

Locations that match the filters, before limit.

messagestring

What to send instead. Present only when no location matches.

Example response

{
  "locations": [
    {
      "woeid": 2344116,
      "name": "Istanbul",
      "country": "Turkey",
      "countryCode": "TR",
      "placeType": "Town",
      "placeTypeCode": 7,
      "parentWoeid": 23424969,
      "url": "http://where.yahooapis.com/v1/place/2344116"
    }
  ],
  "count": 1,
  "total": 1,
  "message": "Unknown placeType. Use country, town, worldwide or unknown."
}

Changes

    • warning

      added the new topup_in_progress enum value to the ///// response property for the response status

    • warning

      added the new topup_in_progress enum value to the ////// response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the ////// response property for the response status

    • warning

      added the new topup_in_progress enum value to the /////// response property for the response status

    • warning

      added the new topup_in_progress enum value to the ////// response property for the response status

    • warning

      added the new topup_in_progress enum value to the /////// response property for the response status