omnischolar / openalex

v1.0.1 2026-11-13 14:57 UTC

Requires

• php: >=8.2
• omnisense/omnischolar: ^1.0
• symfony/http-client: ^6.4|^7.0|^8.0

Requires (Dev)

• phpunit/phpunit: ^11.0

MIT

• Marco Meyer

• citations
• publications
• openalex
• scholarly
• omnischolar
• h-index

Published on Packagist.org on 2026-11-14 02:14 UTC

README

OpenAlex for omnisense/omnischolar: a researcher's profile with their counts (works, citations, h-index, i10-index, by year) and the institutions seen on their works; their works with abstracts, citation counts and open-access links; any work by its OpenAlex id, DOI or PubMed id; a search. No key needed.

$openalex = (new OpenAlexSourceFactory($http))->create(['mailto' => '[e-mail]']);
$openalex->author('A5046427077')->metrics->hIndex;                      // 64
$openalex->works('A5046427077', new Query(from: 2022, to: 2022));       // a Page of Work
$openalex->work('10.1140/epjd/s10053-022-00549-6');

omnischolar:
    sources:
        openalex:
            factory: openalex
            options:
                mailto: '[e-mail]'      # sent with every call, as OpenAlex asks
                api_key: ~                        # free, from openalex.org/settings/api: ten times the keyless daily budget
                paratext: false                   # true keeps covers, tables of contents...

See docs/ for what is read, how it maps, and what OpenAlex does not give.

Install

composer require omnischolar/openalex

It brings the family's core, omnisense/omnischolar, and omnisense/contracts with it. No account and no key; a mailto of yours, sent with every call as OpenAlex asks (a free key raises the daily budget; policy.json). $http is HttpClient::create() in plain PHP.

Usage policy

Declared as data in policy.json (read at https://help.openalex.org/how-to-use-the-api/rate-limits-and-authentication on 2026-11-10), and honoured on every request by the core: a limit reached waits when its window ends within max_wait seconds, else the request is not sent (Usage policies).

• Limits: 10 a second; 1,000 units a day.
• Licence: CC0-1.0; commercial use: allowed.
• Credit: not required.
• Needs: nothing.
• A request counts as entity (free under the daily budget), list (1 credit) or search (10 credits); with an api_key: 30 a second and 10,000 credits a day (OpenAlexSource::usagePolicy()).

Responsibility

This package is an independent, unofficial client: it is not affiliated with, endorsed by or sponsored by OurResearch (OpenAlex). It reaches their service on behalf of whoever runs it, and it does not redistribute their data beyond the short excerpts recorded as test fixtures. Its MIT licence covers this package's code only and grants no right to the service or to its data.

Whoever installs and runs this package is responsible for complying with OpenAlex's terms (openalex.org/terms), for obtaining whatever they require (an account, a key, a licence or subscription, an attribution or a citation, a rate limit to respect), and for any use made of what it returns. The authors publish it free of charge, make no commercial use of it, and accept no liability for how it is used (see LICENSE).

License: MIT since 2026-10-09; earlier versions remain published under LGPL-3.0-or-later.