> ## Documentation Index > Fetch the complete documentation index at: https://docs.scite.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get yearly Scite index for a journal > Get Scite index information for a journal given its slug or a valid ISSN, and an optional list of years. If no year is specified, returns the various Scite index values for all years. To specify one year in the request, use the following format: `/journal/{issn}/yearly-si&years={YEAR_ONE}` To specify multiple years in the request, use the following format: `/journal/{issn}/yearly-si&years={YEAR_ONE}&years={YEAR_TWO}` Response includes a list of objects, each one containing the `twoYearSi`, `fiveYearSi`, `allYearSi` relative to the corresponding year. ## OpenAPI ````yaml /openapi.json get /journal/{issn}/yearly-si openapi: 3.1.0 info: title: Scite API description: >- The Scite API provides publication metadata, Smart Citation tallies, citation graphs, literature search, paper recommendations, collections, Reference Check, Assistant, Evidence datasets, and MCP access. Use the **Documentation** tab for task-oriented guides and the **API Reference** tab for endpoint schemas and parameters. ## Authentication Papers and Tallies endpoints are public. Most other endpoints require a bearer credential: ``` Authorization: Bearer ``` Pro users can create and manage keys in the [API Console](https://scite.ai/users/me/api). Available scopes depend on the account. Enterprise credentials, higher limits, and additional scopes are available through [sales](https://scite.ai/contact). See **Authentication** in the Documentation tab for the access matrix, and **Errors and rate limits** for recovery guidance. Use of the API is subject to the [Scite Terms of Use](https://scite.ai/terms). version: latest x-logo: url: https://cdn.scite.ai/assets/images/logo-blue.svg license: name: Scite Terms of Use url: https://scite.ai/terms servers: - url: https://api.scite.ai description: Production security: - BearerAuth: [] tags: - name: Search description: >- Search metadata and citation statements in Scite. Using the Search API for commercial or research use requires a separate license agreement not covered by individual plans. Please email sales@scite.ai for more information. - name: Paper recommendations description: >- Return papers related to a supplied DOI. Recommendations are available for evaluation with eligible Pro access; commercial or research use requires a separate license agreement. Contact sales@scite.ai for licensing. - name: Papers description: >- Retrieve publication metadata by DOI or PMID, including title, abstract, authors, journal, identifiers, retraction status, and editorial notices. Papers endpoints are public. - name: Tallies description: >- Retrieve Smart Citation tallies by DOI. Tally counts represent citation statements; `citingPublications` represents distinct citing publications. Tallies endpoints are public. - name: Smart Citation Graph description: >- Retrieve citations at the in-text level between and from papers by DOI. For example, given a DOI, get a list of citing DOIs including the section and classification of each citation statement. Snippets are not included in the response. Note that these endpoints are restricted without an API token. - name: References description: |- Retrieve references to and from publications by DOI. Note that these endpoints require an API token for usage. - name: Journal description: |- Retrieve aggregate information about journals by ISSN. ### ISSN Format ### A valid ISSN is in the format `dddd-dddC`, where: ``` - d = any decimal digit (0-9) - C = checksum (0-9 or X) ``` - name: Authors description: Retrieve author metadata and papers by author slug. - name: Collections description: >- Create, retrieve, update, and remove collections: sets of papers monitored over time. A dashboard is a report on a collection. - name: Reference Check description: >- Schedule and retrieve reference check jobs. Note that a paid license is required for this feature (please email sales@scite.ai for more information). For an example output report: [see here](https://scite.ai/reference-check/683e0cbc-b322-4692-be6d-f5432b4a453c). - name: Assistant description: >- Ask research questions and receive answers grounded in Scite citation evidence. The Assistant API is asynchronous: 1. Submit a request with `POST /api_partner/assistant/poll` to receive a task ID. 2. Poll `GET /api_partner/assistant/tasks/{task_id}` until the task completes. Both endpoints require a bearer credential with the `assistant` scope. - name: Evidence description: >- Search patents, clinical trials, and grants via the Resolute evidence datasets. Requires an API token with a per-dataset scope (`evidence:patents:api`, `evidence:grants:api`, `evidence:clinical-trials:api`). Please email sales@scite.ai for access. ## Query parameters ### `q` — free-text query Supports boolean operators (`AND`, `OR`, `NOT`) and phrase matching with double quotes. Examples: `q=CRISPR`, `q="gene therapy" AND cancer`, `q=diabetes NOT type+1` ### `f` — field filters Space-delimited filters in `field:"value"` format. **Values must be quoted** with double quotes. Call `GET /schema` for the full list of filterable fields per dataset. **Patent filters**: `patents.filingStatus` (`"application"`, `"grant"`), `patents.assignees.name`, `patents.inventors.name`, `patents.languages` (ISO 639-1, e.g. `"en"`) **Clinical trial filters**: `trialState.phase` (`"Phase I"` .. `"Phase IV"`, `"N/A"`), `trialState.overallStatus` (`"Recruiting"`, `"Completed"`, …), `conditions`, `interventions.name`, `sponsors.name`, `registry` (`"ClinicalTrials.gov"`, `"UMIN-CTR"`, …), `design.studyType` (`"Interventional"`, `"Observational"`) **Grant filters**: `agency`, `organization`, `piName`, `country` (ISO 3166-1 alpha-3, e.g. `"USA"`, `"GBR"`), `dataSource` (`"NIH RePORTER"`, `"NSF"`, …) Example: `f=trialState.phase:"Phase III" trialState.overallStatus:"Recruiting"` **Date range filters** use `gte` (>=) and `lt` (<) suffixes with ISO dates or epoch milliseconds: `f=dates.startDategte:"2024-01-01" dates.startDatelt:"2025-01-01"`. Epoch ms: `f=dates.startDategte:"1704067200000" dates.startDatelt:"1735689600000"`. Dates without a timezone are interpreted as UTC. Timezone offsets are supported: `"2024-01-01T00:00:00+05:00"`. No space between the field name and the suffix. ### `s` — sort mode Default is `_relevance`. Call `GET /schema` to discover sortable fields per dataset. ## Response format note Some fields in search and detail responses may be either a plain string or an object `{"id": "...", "name": "..."}` (and optionally `"highlighted": "..."`), depending on the query. Consumers should handle both shapes, e.g. `value.id ?? value.name ?? value`. - name: PubMed Source Tallies description: >- Retrieve tallies indicating how many times a given paper was cited by documents of various types from PubMed (e.g. how many times was a given DOI cited by practice guidelines). paths: /journal/{issn}/yearly-si: get: tags: - Journal summary: Get yearly Scite index for a journal description: >- Get Scite index information for a journal given its slug or a valid ISSN, and an optional list of years. If no year is specified, returns the various Scite index values for all years. To specify one year in the request, use the following format: `/journal/{issn}/yearly-si&years={YEAR_ONE}` To specify multiple years in the request, use the following format: `/journal/{issn}/yearly-si&years={YEAR_ONE}&years={YEAR_TWO}` Response includes a list of objects, each one containing the `twoYearSi`, `fiveYearSi`, `allYearSi` relative to the corresponding year. operationId: getJournalYearlySmartCitationIndex parameters: - name: issn in: path required: true schema: type: string title: Issn - name: years in: query required: false schema: type: array items: type: integer description: Years to fetch SI for. Leave empty for all years. examples: - - 2020 - 2021 default: [] title: Years description: Years to fetch SI for. Leave empty for all years. - name: authorization in: header required: false schema: type: string description: Set to `Bearer ` to pass token for authorization. title: Authorization description: Set to `Bearer ` to pass token for authorization. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/JournalYearlySciteIndexesRS' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' components: schemas: JournalYearlySciteIndexesRS: items: $ref: '#/components/schemas/JournalYearlySciteIndexRS' type: array title: JournalYearlySciteIndexesRS example: - issns: - 0006-3223 relativeYear: '2021' siAllYears: 0.8731623106623106 siFiveYears: 0.9063056644104026 siTwoYears: 0.9178082191780822 - issns: - 0006-3223 relativeYear: '2020' siAllYears: 0.8729605900320345 siFiveYears: 0.9001824341933803 siTwoYears: 0.9102272727272728 HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError JournalYearlySciteIndexRS: properties: relativeYear: anyOf: - type: string - type: 'null' title: Relativeyear siTwoYears: anyOf: - type: number - type: 'null' title: Sitwoyears siFiveYears: anyOf: - type: number - type: 'null' title: Sifiveyears siAllYears: anyOf: - type: number - type: 'null' title: Siallyears issns: anyOf: - items: type: string type: array - type: 'null' title: Issns type: object title: JournalYearlySciteIndexRS ErrorResponse: type: object properties: detail: type: string description: Human-readable error detail. required: - detail title: ErrorResponse ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError responses: Unauthorized: description: The request is missing a valid bearer credential. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Forbidden: description: >- The credential is valid, but the key or account lacks the required scope. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' NotFound: description: The requested resource was not found. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' TooManyRequests: description: >- The request exceeded a rate limit. Inspect the rate-limit headers before retrying. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' InternalServerError: description: The server encountered an unexpected error. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: API key or JWT ````