omnischolar/orcid API reference

Omnischolar\Orcid

OrcidSource class

final class OrcidSource extends HttpSource OrcidSource.php:31

ORCID's public API (pub.orcid.org/v3.0, no key): who a researcher says they are - names, biography, keywords, pages - their CV - employments, education, qualifications, distinctions, invited positions, memberships, services - and the works on their record, each in the version they prefer, with its contributors.

Only what the researcher made public is served. ORCID searches people, not works: search() is not supported.

const BASE_URI = 'https://pub.orcid.org/v3.0/'

OrcidSource::__construct()

public function __construct(HttpClientInterface $http, string $baseUri = self::BASE_URI, array $headers = [], float $throttle = 0.0)

OrcidSource::getName()

public function getName(): string

OrcidSource::capabilities()

public function capabilities(): array

OrcidSource::author()

public function author(Identifier|string $author): ?Author

OrcidSource::works()

public function works(Identifier|string $author, ?Query $query = null): Page

The works on the record - one per group, the version the researcher prefers - newest first, then detailed page by page (contributors, journal, description). ORCID lists them all at once: the query's years and types are applied here, and the cursor is an offset.

OrcidSource::work()

public function work(Identifier|string $id): ?Work

One work on a record: "0000-0002-1825-0097/work/9543020" (or "0000-0002-1825-0097:9543020").

OrcidSourceFactory class

final class OrcidSourceFactory extends SourceFactory OrcidSourceFactory.php:17

ORCID's public API: identity, CV, declared works - no key.

options: base_uri: 'https://pub.orcid.org/v3.0/' # the sandbox: https://pub.sandbox.orcid.org/v3.0/ throttle: 0 # seconds between two calls

Options