---
title: "Get search results from a query"
method: GET
path: "/api_partner/search"
tags: ["Search"]
---

# Get search results from a query

`GET /api_partner/search`

## Query parameters

- `format` 'json' | 'csv' | 'ris' — Result format.
- `term` string, nullable — Cross-field search term. Can be left blank.
- `mode` 'all' | 'citations' | 'papers' | 'question-answering' — Select search mode, see above.
- `limit` integer — How many results to fetch. Up to 10,000 can be fetched at once.
- `offset` integer — Can be used for pagination in combination with `limit`.
- `sort` 'date' | 'total_cited' | 'total_supported' | 'total_contrasted' | 'total_mentioned' | 'total_citing_publications', nullable — How the results should be sorted. Leave blank for generic query 'relevance'.
- `sort_order` 'asc' | 'desc', nullable — Result sort order for selected sort.
- `title` string, nullable — Match text in publication title.
- `abstract` string, nullable — Match text in publication abstract.
- `doi` string, nullable — Scope the search to a single DOI (exact match). Convenience alias for a one-element `dois`. Combine with `term` to search within a known publication.
- `dois` string[] — Scope the search to one or more specific DOIs (exact match). Combine with `term` to search within a known publication.
- `date_from` string, nullable — Match publications published from this date onwards (YYYY-MM-DD or just YYYY).
- `date_to` string, nullable — Match publications published up to this date (YYYY-MM-DD or just YYYY).
- `citation_types` string[] — Match smart citations of certain types.
- `has_retraction` boolean, nullable — Publication has retraction or not.
- `has_concern` boolean, nullable — Publication has editorial concern or not.
- `has_correction` boolean, nullable — Publication has correction or not.
- `has_erratum` boolean, nullable — Publication has erratum or not.
- `has_withdrawn` boolean, nullable — Publication has been withdrawn or not.
- `has_tally` boolean, nullable — Publication has smart citations made towards it or not (i.e. a scite tally of > 0).
- `supporting_from` integer, nullable — Number of supporting citations made from publication. Leave blank for any count.
- `supporting_to` integer, nullable — Number of supporting citations made toward publication. Leave blank for any count.
- `mentioning_from` integer, nullable — Number of mentioning citations made from publication. Leave blank for any count.
- `mentioning_to` integer, nullable — Number of mentioning citations made toward publication. Leave blank for any count.
- `contrasting_from` integer, nullable — Number of contrasting citations made from publication. Leave blank for any count.
- `contrasting_to` integer, nullable — Number of contrasting citations made toward publication. Leave blank for any count.
- `citing_publications_from` integer, nullable — Number of traditional citations made from publication AKA the number of references. Leave blank for any count.
- `citing_publications_to` integer, nullable — Number of traditional citations made toward publication. Leave blank for any count.
- `author` string, nullable — Publication author name.
- `authors` string[]
- `journal` string, nullable — Journal in which publication appears.
- `journals` string[]
- `publisher` string, nullable — Publisher of the publication.
- `section` string, nullable — Publication section in which citation statement appears.
- `sections` string[]
- `paper_type` string, nullable — Publication type.
- `paper_types` string[]
- `affiliation` string, nullable — Author affiliation.
- `affiliations` string[]
- `topic` string, nullable — Publication topic.
- `topics` string[]
- `substances` string[] — Pubchem substance canonical name.
- `mesh_type` string[] — Pubmed mesh descriptor and/or qualifier for publication.
- `compute_aggregations` boolean — For a given search query, this flag will control whether counts are computed and returned for the possible aggregations.
- `aggregations` string[] — List of aggregation types to compute counts for. Only used if `compute_aggregations` is true.

## Headers

- `authorization` string — Set to `Bearer <token>` to pass token for authorization.

## Response `200`

Successful Response

- SearchResultsResponse
  - `count` integer, required
  - `countIsApproximate` boolean
  - `aggregations` AggregationSchema, required
    - `paperTypes` AggregationBucketSchema[]
      - `key` union, required
        - string
        - string[]
      - `docCount` integer, required
      - `metadata` object
    - `journals` AggregationBucketSchema[]
      - `key` union, required
        - string
        - string[]
      - `docCount` integer, required
      - `metadata` object
    - `topics` AggregationBucketSchema[]
      - `key` union, required
        - string
        - string[]
      - `docCount` integer, required
      - `metadata` object
    - `substances` AggregationBucketSchema[]
      - `key` union, required
        - string
        - string[]
      - `docCount` integer, required
      - `metadata` object
    - `meshDescriptors` AggregationBucketSchema[]
      - `key` union, required
        - string
        - string[]
      - `docCount` integer, required
      - `metadata` object
    - `editorialNotices` AggregationBucketSchema[]
      - `key` union, required
        - string
        - string[]
      - `docCount` integer, required
      - `metadata` object
    - `authors` AggregationBucketSchema[]
      - `key` union, required
        - string
        - string[]
      - `docCount` integer, required
      - `metadata` object
    - `affiliations` AggregationBucketSchema[]
      - `key` union, required
        - string
        - string[]
      - `docCount` integer, required
      - `metadata` object
    - `dateHistogram` DateBucket[]
      - `docCount` integer, required
      - `total` integer, required
      - `supporting` integer, required
      - `contradicting` integer, required
      - `mentioning` integer, required
      - `unclassified` integer, required
      - `date` string, date, required
    - `maxDate` string, date-time, nullable — Maximum Date
    - `minDate` string, date-time, nullable — Minimum Date
  - `hits` SearchResultSchema[], required
    - `id` string, nullable
    - `doi` string, nullable
    - `title` string, nullable
    - `slug` string, nullable
    - `authors` AuthorResults[], nullable
      - `authorName` string, nullable
      - `authorSlug` string, nullable
      - `authorSequenceNumber` union
        - string
        - integer
      - `affiliation` string, nullable
      - `affiliationSlug` string, nullable
    - `journal` string, nullable
    - `shortJournal` string, nullable
    - `publisher` string, nullable
    - `memberId` integer, nullable
    - `abstract` string, nullable
    - `year` integer, nullable
    - `date` string, date, nullable
    - `lastUpdate` integer, nullable
    - `volume` string, nullable
    - `issue` string, nullable
    - `page` string, nullable
    - `tally` TallyResponse
      - `total` integer, required
      - `supporting` integer, required
      - `contradicting` integer, required
      - `mentioning` integer, required
      - `unclassified` integer, required
      - `doi` string, nullable
      - `citingPublications` integer, nullable
    - `issns` string[], nullable
    - `editorialNotices` EditorialNoticeSchema[]
      - `status` string, nullable
      - `date` string, nullable
      - `noticeDoi` string, nullable
      - `doi` string, required
      - `urls` string[], nullable
    - `normalizedTypes` string[]
    - `isOa` boolean
    - `oaStatus` string
    - `meshTypes` PubmedMeshTypeResponse[]
      - `descriptorId` string, required
      - `descriptorName` string, required
      - `qualifierId` string, nullable
      - `qualifierName` string, nullable
    - `relevancyScore` number, nullable
    - `citations` CitationSearch[]
      - `id` integer, nullable
      - `source` string, required
      - `target` string, required
      - `negative` number, nullable
      - `positive` number, nullable
      - `neutral` number, nullable
      - `section` string, nullable
      - `expertClassification` string, nullable
      - `type` string, nullable
      - `typeConfidence` number, nullable
      - `snippet` string, required
      - `lang` string, nullable
      - `langConfidence` number, nullable
      - `refLocation` string, nullable
      - `memberId` integer, nullable
      - `selfCites` SelfCiteSchema[]
        - `type` string, nullable, required
        - `family` string, nullable, required
        - `given` string, nullable, required
      - `snippetHidden` boolean
    - `fulltextExcerpts` string[]
    - `highlightedFields` string[]
  - `suggestedTerm` string, nullable
  - `restrictedCites` boolean

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/scite/apis/scite-api.md) · [All operations](https://skmtc.net/scite/apis/scite-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/scite/scite-api/revisions/9f4cba020e89/schema)