Request format
| Parameter | Required | Description |
|---|---|---|
entity_type | Optional | works, authors, sources, institutions, concepts, publishers, or funders |
q | Yes | The search string |
Response format
Result properties
| Property | Description |
|---|---|
id | OpenAlex ID |
external_id | Canonical external ID (DOI, ORCID, ROR, etc.) |
display_name | Entity name |
entity_type | work, author, source, institution, concept, publisher, funder |
cited_by_count | Citation count (for works) or sum of citations for linked works |
works_count | Number of associated works (null for works) |
hint | Additional context to help identify the result |
The hint property
Hints help users distinguish between similar results:
| Entity | Hint content |
|---|---|
| Work | Authors’ names (e.g., “R. Alexander Pyron, John J. Wiens”) |
| Author | Last known institution (e.g., “University of North Carolina, USA”) |
| Source | Host organization (e.g., “Oxford University Press”) |
| Institution | Location (e.g., “Gainesville, USA”) |
| Concept | Description (e.g., “the study of plant species and genera”) |