Citeometer

How far has your paper travelled? A lightweight, zero-dependency embeddable JavaScript widget and Web Component to gracefully display scholarly publication metrics (citations, recent reads, PDF downloads, and views) on personal academic websites and GitHub Pages.

Live demo and embed generator: https://yohanchatelain.github.io/citeometer/

---

🌟 Supported Public APIs

Curated from public academic APIs (including GitHub awesome-public-apis, awesome-open-science, and open bibliometric indexes):

Platform	Endpoint / Source	Metric Types	Requires Key?
OpenAlex	api.openalex.org/works	Total Citations, Annual Trend, OA status	❌ No (CORS enabled)
Semantic Scholar	api.semanticscholar.org/graph/v1	Citations, Influential Citations	❌ No (CORS enabled)
Crossref	api.crossref.org/works	Official DOI Citations, References count	❌ No (CORS enabled)
Europe PMC	ebi.ac.uk/europepmc/webservices	Citations, PubMed Central links	❌ No (CORS enabled)
PLOS COUNTER	counter.plos.org/api/v1.0/stats	COUNTER 5 HTML views, PDF downloads, Total	❌ No (CORS enabled)
Zenodo	zenodo.org/api/records	Software & Dataset Downloads & Views	❌ No (CORS enabled)
DataCite	api.datacite.org/dois	Dataset/Software Citations, Views, Downloads	❌ No (CORS enabled)
OpenCitations	opencitations.net/index/api/v2	Open CC0 DOI Citation Counts	❌ No (CORS enabled)
GitHub	api.github.com/repos & /orgs	Stars, Forks, Release Downloads, Org Totals; 14-day Clones & Views (snapshot)	❌ No (CORS enabled; token for 14d traffic)
Docker Hub	hub.docker.com/v2/repositories	Container Image Pull Counts	❌ No (snapshot + Shields CORS fallback)
PyPI	pypistats.org/api/packages	Python Package Downloads (180d & monthly)	❌ No (snapshot + Shields CORS fallback)
npm	api.npmjs.org/downloads	JavaScript Package Downloads	❌ No (CORS enabled)
NASA ADS	api.adsabs.harvard.edu	Recent 90-day read counts, ADS citations	❌ No, but snapshot only (no CORS)
bioRxiv	api.biorxiv.org + article metrics page	Published DOI linkage (live); PDF downloads & views (snapshot only)	❌ No

---

🚀 Quickstart

1. Include the Library

Add one script tag to your HTML <head>. The bundle injects its own styles:

<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/citeometer.min.js" defer></script>

Prefer to load the stylesheet yourself? Use dist/citeometer.min.css alongside src/citeometer.js.

2. Use the Custom Web Component <cite-o-meter>

(The legacy <paper-metrics> tag, .paper-metrics class and window.PaperMetrics global still work as aliases.)

Provide whatever identifiers you have for your paper:

Compact Inline Badge (for publication lists)

<cite-o-meter 
  doi="10.1371/journal.pone.0295069" 
  ads="2024PLoSO..1995069S" 
  layout="badge">
</cite-o-meter>

Rich Interactive Card

<cite-o-meter 
  title="Longitudinal brain structure changes in Parkinson's disease: a replication study"
  doi="10.1371/journal.pone.0295069" 
  ads="2024PLoSO..1995069S"
  layout="card">
</cite-o-meter>

Software / Dataset with Zenodo

<cite-o-meter 
  title="Verificarlo: Floating-point precision and numerical variability toolkit"
  zenodo="8301008" 
  layout="badge">
</cite-o-meter>

---

⚙️ Configuration Attributes

Attribute	Description	Example
doi	Digital Object Identifier (or DOI URL)	10.1371/journal.pone.0295069
arxiv	arXiv identifier (or arXiv URL)	2610.01889
ads / ads-bibcode	NASA ADS bibcode	2024PLoSO..1995069S
ads-reads	Static/cached ADS 90-day reads	831
zenodo	Zenodo record ID (or Zenodo DOI/URL)	8301008
plos-doi	Explicit PLOS DOI for COUNTER stats	10.1371/journal.pone.0295069
biorxiv	bioRxiv / medRxiv DOI	10.1101/2024.11.11.623071v1
biorxiv-pdfs	Static/cached bioRxiv PDF download count	1420
biorxiv-views	Static/cached bioRxiv abstract/HTML view count	4850
github	GitHub owner/repo, organization (org), or repo URL	verificarlo/verificarlo
github-clones	Static/cached GitHub 14-day git clone count	979
github-views	Static/cached GitHub 14-day repository view count	89
docker	Docker Hub for container pulls

---

以上為 README 的開頭部分。其餘內容請閱讀原文。 檢視完整 README ↗