Skip to main content
POST
/
api
/
openalex
/
autocomplete
/openalex/autocomplete
curl --request POST \
  --url https://api.anysite.io/api/openalex/autocomplete \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "query": "<string>",
  "count": 5,
  "timeout": 300,
  "entity_type": "works"
}
'
[
  {
    "id": "<string>",
    "@type": "@openalex_autocomplete_item",
    "display_name": "",
    "type": "<string>",
    "hint": "<string>",
    "cited_by_count": 123,
    "works_count": 123,
    "external_id": "<string>"
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
query
string
required

Partial query to autocomplete

Minimum string length: 1
Example:

"machine learn"

count
integer
required

Number of suggestions to return

Required range: 1 <= x <= 10
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
entity_type
enum<string>
default:works

Entity type to autocomplete against

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

Response

Successful Response

id
string
required
@type
string
default:@openalex_autocomplete_item
display_name
string
default:""
type
string | null
hint
string | null
cited_by_count
integer | null
works_count
integer | null
external_id
string | null