Autocompletes
Show me this endpoint for

About

The autocompletes endpoint a string of characters provided to it, and then returns suggested terms that are the most likely full words or strings. The terms returned by the News API are based on parameters the type parameters you can see below.

For example, if you provide the autocompletes endpoint with the term New York C and select the type dbpedia_resources, the API will return links to the DBpedia resources New_York_City, New_York_City_Subway, New_York_City_Police_Department, and so on.

Parameters

Name Type Description Notes
type String This parameter is used for defining the type of autocompletes. [enum: source_names, source_domains, entity_types, dbpedia_resources]
term String This parameter is used for finding autocomplete objects that contain the specified value.
language String This parameter is used for autocompletes whose language is the specified value. It supports ISO 639-1 language codes. [optional] [default to en] [enum: en, de, fr, it, es, pt]
per_page Integer This parameter is used for specifying number of items in each page. [optional] [default to 3]

Return type

Autocompletes

Example

# load the gem
require 'aylien_news_api'

# setup authorization
AylienNewsApi.configure do |config|
  # Configure API key authorization: app_id
  config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR_APP_ID'

  # Configure API key authorization: app_key
  config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR_APP_KEY'
end

api_instance = AylienNewsApi::DefaultApi.new

type = "dbpedia_resources"
term = "obam"

opts = { 
  language: "en",
  per_page: 3
}

begin
  #List autocompletes
  result = api_instance.list_autocompletes(type, term, opts)
  puts result
rescue AylienNewsApi::ApiError => e
  puts "Exception when calling DefaultApi->list_autocompletes: #{e}"
end