Autocomplete search

Fast typeahead search returning up to 10 results. Use for search-as-you-type interfaces.

GET /autocomplete/{entity_type}

Autocomplete search

cURL

curl --request GET \
  --url 'https://api.openalex.org/autocomplete/{entity_type}?api_key='

import requests

url = "https://api.openalex.org/autocomplete/{entity_type}?api_key="

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.openalex.org/autocomplete/{entity_type}?api_key=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.openalex.org/autocomplete/{entity_type}?api_key=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.openalex.org/autocomplete/{entity_type}?api_key="

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.openalex.org/autocomplete/{entity_type}?api_key=")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.openalex.org/autocomplete/{entity_type}?api_key=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

200

{
  "meta": {
    "count": 123,
    "db_response_time_ms": 123
  },
  "results": [
    {
      "id": "<string>",
      "display_name": "<string>",
      "hint": "<string>",
      "cited_by_count": 123,
      "works_count": 123,
      "entity_type": "<string>",
      "external_id": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

Authorizations

api_key · string · query · required

Your OpenAlex API key. Get a free key at https://openalex.org/settings/api

Path Parameters

entity_type · enum<string> · required

Type of entity to search

Available options: works, authors, sources, institutions, topics, keywords, publishers, funders

Query Parameters

q · string · required

Search query string

filter · string

Filter results using field:value syntax. Multiple filters can be combined with commas (AND) or pipes (OR). Available fields vary by entity type.

api_key · string · required

Your OpenAlex API key (required). Get a free key at https://openalex.org/settings/api

Response

200

application/json

Successful response

meta · object

Show child attributes

results · object[]

Show child attributes