Name: ScholarBrief API: DOI Metadata, Citations and Attention
Brand: visionwell
SKU: api-visionwell-scholarbrief
Availability: InStock
Author: API Market

binbin7418-dotcom

# ScholarBrief DOI Research Brief API

## Overview

The ScholarBrief API turns DOIs into research briefs. For each DOI it returns the Crossref record (title, authors, journal, publisher, year, citation and reference counts) and, when it can match the paper to a Wikipedia article, that article's page views over the last days as a measure of public attention. A summary ranks the batch by citations and by page views.

It is built for research offices, librarians, science journalists and bibliometrics tools that need quick facts about a list of papers. Send up to 25 DOIs per call, or one at a time.

## Features

*   **3 endpoints**: batch brief, single brief and health check.
*   **Crossref metadata**: title, first authors, journal, publisher, year, citations and references.
*   **Public attention**: Wikipedia page views for a matched article.
*   **Summary**: top paper by citations and by page views.
*   **Up to 25 DOIs**: per batch call.
*   **Rate limit**: up to 10 requests per second on every plan.

## Use Cases

*   **Research offices**: report on a department's publications.
*   **Libraries**: enrich reading lists with citation counts.
*   **Science journalism**: check how widely a paper is cited and read.
*   **Bibliometrics**: compare papers by citations and attention.

## API Documentation

### Base URL

All requests go through the API.market proxy at this base URL:

```
https://prod.api.market/api/v1/visionwell/scholarbrief
```

### Authentication

Every request must include your API.market key in the `x-api-market-key` header:

```
x-api-market-key: YOUR_API_KEY
```

Replace `YOUR_API_KEY` with your actual API key.

### Endpoints

#### 1. Brief a batch of DOIs

Returns a brief for each DOI and a summary for the batch.

**Method:** `POST`

**Endpoint:** `/brief/batch`

**Parameters:**

| Name | In | Description | Type | Required | Default | Max Value |
|---|---|---|---|---|---|---|
| dois | body | DOIs to brief, such as `10.1038/nature14539` | array of strings | Yes | - | 25 |
| project | body | Wikipedia project for page views, such as `en.wikipedia` | string | No | en.wikipedia | - |
| days | body | Number of days of page views to count | integer | No | 30 | 90 |

**Example Request:**

```bash
curl -X POST 'https://prod.api.market/api/v1/visionwell/scholarbrief/brief/batch' \
  -H 'x-api-market-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "dois": [
    "10.1038/nature14539",
    "10.1038/nature12373"
  ]
}'
```

**Example Response (200 OK):**

```json
{
  "scope": "ScholarBrief joins two public sources at query time for each DOI: the bibliographic record deposited in Crossref (title, first 8 authors, journal, publisher, ye...",
  "results": [
    {
      "doi": "10.1038/nature14539",
      "errors": [],
      "found": true,
      "work": {
        "doi": "10.1038/nature14539",
        "title": "Deep learning",
        "authors": [
          "Yann LeCun"
        ],
        "authorsScope": "first 8 authors",
        "year": 2015,
        "type": "journal-article",
        "publisher": "Springer Science and Business Media LLC",
        "journal": "Nature",
        "issn": [
          "0028-0836"
        ],
        "volume": "521",
        "pages": "436-444",
        "citedByCount": 79210,
        "referenceCount": 103,
        "citationCountsNote": "Crossref counts at query time",
        "url": "https://doi.org/10.1038/nature14539",
        "abstractExcerpt": null,
        "subjects": []
      },
      "attention": {
        "signal": "Wikipedia pageviews",
        "signalNote": "Views of one Wikipedia article over the window below - one partial signal of public attention, not an altmetric score and not overall attention.",
        "project": "en.wikipedia",
        "window": {
          "start": "2026-10-08",
          "end": "2026-11-06",
          "days": 30
        },
        "match": {
          "status": "matched",
          "method": "title-exact",
          "score": 1,
          "matchedTitle": "Deep_learning",
          "matchedTitleDisplay": "Deep learning",
          "matchedUrl": "https://en.wikipedia.org/wiki/Deep_learning",
          "bestCandidate": null
        },
        "pageviews": {
          "totalViews": 45982,
          "averageDailyViews": 1533,
          "days": 30,
          "series": [
            {
              "date": "2026-10-08",
              "views": 2221
            }
          ],
          "countingNote": "Wikimedia counts views under this exact article title; views arriving via a redirect title are counted under the redirect's own title and are not merged into th..."
        },
        "note": "Title matching: the Crossref title is searched on Wikipedia and a candidate article is accepted only on an exact normalised-title match or a token-overlap score..."
      }
    }
  ],
  "summary": {
    "total": 2,
    "resolved": 2,
    "notFound": 0,
    "errored": 0,
    "withWikipediaMatch": 1,
    "noConfidentMatch": 1,
    "attentionFailed": 0,
    "totalCitedBy": 81073,
    "totalPageviews": 45982,
    "topByCitations": {
      "doi": "10.1038/nature14539",
      "title": "Deep learning",
      "citedByCount": 79210
    },
    "topByPageviews": {
      "doi": "10.1038/nature14539",
      "article": "Deep learning",
      "totalViews": 45982
    }
  }
}
```

#### 2. Brief one DOI

Returns the brief for one DOI.

**Method:** `POST`

**Endpoint:** `/brief/single`

**Parameters:**

| Name | In | Description | Type | Required | Default | Max Value |
|---|---|---|---|---|---|---|
| doi | body | The DOI to brief | string | Yes | - | - |
| project | body | Wikipedia project for page views, such as `en.wikipedia` | string | No | en.wikipedia | - |
| days | body | Number of days of page views to count | integer | No | 30 | 90 |

**Example Request:**

```bash
curl -X POST 'https://prod.api.market/api/v1/visionwell/scholarbrief/brief/single' \
  -H 'x-api-market-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "doi": "10.1038/nature14539"
}'
```

**Example Response (200 OK):**

```json
{
  "scope": "ScholarBrief joins two public sources at query time for each DOI: the bibliographic record deposited in Crossref (title, first 8 authors, journal, publisher, ye...",
  "results": [
    {
      "doi": "10.1038/nature14539",
      "errors": [],
      "found": true,
      "work": {
        "doi": "10.1038/nature14539",
        "title": "Deep learning",
        "authors": [
          "Yann LeCun",
          "Yoshua Bengio"
        ],
        "authorsScope": "first 8 authors",
        "year": 2015,
        "type": "journal-article",
        "publisher": "Springer Science and Business Media LLC",
        "journal": "Nature",
        "issn": [
          "0028-0836",
          "1476-4687"
        ],
        "volume": "521",
        "pages": "436-444",
        "citedByCount": 79210,
        "referenceCount": 103,
        "citationCountsNote": "Crossref counts at query time",
        "url": "https://doi.org/10.1038/nature14539",
        "abstractExcerpt": null,
        "subjects": []
      },
      "attention": {
        "signal": "Wikipedia pageviews",
        "signalNote": "Views of one Wikipedia article over the window below - one partial signal of public attention, not an altmetric score and not overall attention.",
        "project": "en.wikipedia",
        "window": {
          "start": "2026-10-08",
          "end": "2026-11-06",
          "days": 30
        },
        "match": {
          "status": "matched",
          "method": "title-exact",
          "score": 1,
          "matchedTitle": "Deep_learning",
          "matchedTitleDisplay": "Deep learning",
          "matchedUrl": "https://en.wikipedia.org/wiki/Deep_learning",
          "bestCandidate": null
        },
        "pageviews": {
          "totalViews": 45982,
          "averageDailyViews": 1533,
          "days": 30,
          "series": [
            {
              "date": "2026-10-08",
              "views": 2221
            },
            {
              "date": "2026-10-09",
              "views": 1629
            }
          ],
          "countingNote": "Wikimedia counts views under this exact article title; views arriving via a redirect title are counted under the redirect's own title and are not merged into th..."
        },
        "note": "Title matching: the Crossref title is searched on Wikipedia and a candidate article is accepted only on an exact normalised-title match or a token-overlap score..."
      }
    }
  ],
  "summary": {
    "total": 1,
    "resolved": 1,
    "notFound": 0,
    "errored": 0,
    "withWikipediaMatch": 1,
    "noConfidentMatch": 0,
    "attentionFailed": 0,
    "totalCitedBy": 79210,
    "totalPageviews": 45982,
    "topByCitations": {
      "doi": "10.1038/nature14539",
      "title": "Deep learning",
      "citedByCount": 79210
    },
    "topByPageviews": {
      "doi": "10.1038/nature14539",
      "article": "Deep learning",
      "totalViews": 45982
    }
  }
}
```

#### 3. Health check

Returns the service status. It is a quick way to check that your key and the ScholarBrief service are working.

**Method:** `GET`

**Endpoint:** `/health`

**Parameters:** None.

**Example Request:**

```bash
curl -X GET 'https://prod.api.market/api/v1/visionwell/scholarbrief/health' \
  -H 'x-api-market-key: YOUR_API_KEY'
```

**Example Response (200 OK):**

```json
{
  "ok": true,
  "service": "ScholarBrief",
  "version": 1
}
```

## Status Codes

| Code | Status | Description |
|---|---|---|
| 200 | OK | The request succeeded and the response body holds the result. |
| 400 | Bad Request | A required parameter is missing or a value is invalid. Check the parameter table for the endpoint. |
| 401 | Unauthorized | The `x-api-market-key` header is missing or the key is not valid. |
| 403 | Forbidden | Your key is valid but your subscription does not allow this request, for example an endpoint outside your plan. |
| 404 | Not Found | The path does not exist, or the resource you asked for was not found. |
| 429 | Too Many Requests | You sent more than 10 requests per second. Slow down and retry, honouring the `Retry-After` header. |
| 500 | Internal Server Error | Something went wrong while processing the request. Retry after a short wait. |
| 503 | Service Unavailable | The service or its upstream data source is temporarily unavailable. Retry with backoff. |

## Rate Limits

Every plan allows up to 10 requests per second. Subscription plans also have a monthly call quota shown on the pricing page. Sending more than 10 requests per second returns `429 Too Many Requests`. Throttle your client to stay under 10 requests per second, back off and retry when you get a 429, and honour the `Retry-After` header when it is present.

## FAQ

*   **Why do some DOIs have no page views?**

    Page views are only returned when the paper confidently matches a Wikipedia article. Most papers have no article of their own.

*   **Where do citation counts come from?**

    From Crossref's `is-referenced-by` count, which can differ from Google Scholar or Scopus.

*   **Can I send a DOI link?**

    Send the DOI itself, such as `10.1038/nature14539`.

## Contact Us

If you have any questions or need assistance, you can reach out to us through the embedded chat on the bottom right corner of the page or send an email to hello@magicapi.com.


Brief up to 25 DOIs per call with Crossref metadata and citation counts, plus Wikipedia page views for public attention.

ScholarBrief API: DOI Metadata, Citations and Attention