Skip to main content
POST
/
api
/
orcid
/
researchers
/
search
/orcid/researchers/search
curl --request POST \
  --url https://api.anysite.io/api/orcid/researchers/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "query": "<string>",
  "count": 2,
  "timeout": 300
}
'
[
  {
    "orcid": "<string>",
    "@type": "@orcid_researcher_search_result",
    "given_name": "<string>",
    "family_name": "<string>",
    "credit_name": "<string>",
    "other_names": [],
    "emails": [],
    "institution_names": []
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
query
string
required

Search expression. Supports field-scoped terms combined with AND/OR, e.g. 'family-name:Smith AND given-names:John', 'keyword:altmetrics', 'affiliation-org-name:Stanford', 'digital-object-ids:10.1000/xyz', or free text 'text:genomics'.

Minimum string length: 1
Examples:

"family-name:Smith AND given-names:John"

"keyword:scientometrics"

​
count
integer
required

Number of researchers to return

Required range: x >= 1
​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500

Response

Successful Response

​
orcid
string
required
​
@type
string
default:@orcid_researcher_search_result
​
given_name
string | null
​
family_name
string | null
​
credit_name
string | null
​
other_names
string[]
​
emails
string[]
​
institution_names
string[]