omnischolar / openalex

1.x-dev 2026-10-17 13:45 UTC

Requires

• php: >=8.2
• omniscient/omnischolar: ^1.0@dev
• 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-10-17 13:54 UTC

README

OpenAlex for omniscient/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('A5108007452')->metrics->hIndex;                      // 51
$openalex->works('A5108007452', new Query(from: 2024, to: 2024));       // a Page of Work
$openalex->work('10.1039/d4sc04973j');

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.

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.