Tweets

Finds places on X by name. Pass a place's id as place to /x/tweets/search to read posts tagged there. X ranks the places, so their order can differ between requests. Each returned place costs 1 credit.

get/api/v1/x/places/search

Request

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

Query parameters

qstring required

Place name to search for, such as istanbul. Alias query. Xquik's cap is 4,096 characters.

limitinteger

Maximum places to return. Omit it for every place X finds. 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

Places X found for the name

countinteger required

Places returned & charged.

totalinteger required

Places X found, before limit.

messagestring

What to send instead. Present only when X finds no place.

Example response

{
  "places": [
    {
      "id": "5e02a0f0d91c76d2",
      "name": "İstanbul",
      "fullName": "İstanbul, Türkiye",
      "country": "Turkey",
      "countryCode": "TR",
      "placeType": "city",
      "url": "https://api.twitter.com/1.1/geo/id/5e02a0f0d91c76d2.json",
      "centroid": [
        28.84318392941324,
        41.054196399999995
      ],
      "boundingBox": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              28.6321043,
              40.8027337
            ],
            [
              28.6321043,
              41.2399073
            ],
            [
              29.3783413,
              41.2399073
            ],
            [
              29.3783413,
              40.8027337
            ]
          ]
        ]
      },
      "attributes": {},
      "containedWithin": []
    }
  ],
  "count": 1,
  "total": 1,
  "message": "X found no place for that text. Try a city or country name."
}

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