Clarivate XML API

Response in xml format

Documentation GitHub OpenAPI

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /DocumentLevelMetricsByInstitutionId/xml Get my institution's document metrics as XML · Get metrics by institution Id #

Ask an LLM

“How do I pull document level metrics for all of my institution's papers in a year as XML?”

“Can I page through institution-wide InCites metrics in XML?”

Tell an agent

Get XML document metrics for {year}: {recordcount} records from {startingrecord}, version {ver}, key {apiKey}.

Fetch {recordcount} institution metric records in XML for {year} starting at {startingrecord}, schema {schema}, ver {ver}, key {apiKey}.

GET /DocumentLevelMetricsByInstitutionIdRecordCount/xml Count my institution's records for a year (XML) · Get metrics count by year #

Ask an LLM

“How many records are unified to my institution in a given year, in XML?”

“How do I know how many pages of XML institution metrics to request?”

Tell an agent

Count my institution's records for {year} in XML with key {apiKey}.

Return the XML record count for year {year} using API key {apiKey}.

GET /DocumentLevelMetricsByUT/xml Get document metrics for a UT (XML) · Get metrics by UT #

Ask an LLM

“How do I get InCites metrics for one Web of Science accession number in XML?”

“Can I include ESCI documents when looking up a UT's metrics as XML?”

Tell an agent

Get XML metrics for UT {UT}, version {ver}, key {apiKey}.

Fetch XML document metrics for {UT} with esci {esci}, ver {ver}, key {apiKey}.

GET /CheckValidUTs/xml Find invalid UTs in a list (XML) · Get invalid UTs #

Ask an LLM

“Which accession numbers in my list are not valid UTs, returned as XML?”

“Can I validate a batch of UTs before requesting XML metrics?”

Tell an agent

Check which of {UT} are invalid, XML output, key {apiKey}.

Validate the UT list {UT} as XML with API key {apiKey}.

GET /InCitesLastUpdated/xml Get InCites data update times (XML) · Get last updated information #

Ask an LLM

“When were the InCites and Web of Science datasets last updated, in XML?”

“How fresh is the InCites data behind the XML metrics?”

Tell an agent

Get the InCites last-updated dates in XML with key {apiKey}.

Show when the XML InCites and WoS indexes were last refreshed, key {apiKey}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/clarivate:clarivate-xml-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: InCites Document Level Metrics XML API
  description: The InCites API provides document level metrics from InCites to support integration with Institutional Repository (IR) and Current Research Information Systems (CRIS). Ask your account manager about subscribing to the InCites API, or contact our support team to let us know you are interested.
  version: 2.0.0
servers:
- url: https://incites-api.clarivate.com/api/incites
security:
- key: []
tags:
- name: XML
  description: Response in xml format
paths:
  /DocumentLevelMetricsByInstitutionId/xml:
    get:
      tags:
      - XML
      summary: Get metrics by institution Id
      description: Find all document level metrics for a given institution
      parameters:
      - name: X-ApiKey
        in: header
        description: Developer Key parameter, authenticates you to use the service and ties your institution id to the call. Previous versions of this API supported this as a query parameter with the key 'X-TR-API-APP-ID'. This construct will be supported for a time, but going forward, this parameter should be passed in the header
        required: true
        schema:
          type: string
      - name: year
        in: query
        description: Your response will contain records published starting in this year. Must be at least 1980
        required: true
        schema:
          type: string
      - name: recordcount
        in: query
        description: This is the maximum number of records that will be returned per request. Must be less than the limit placed on the developer key (default maximum is 100)
        required: true
        schema:
          type: integer
      - name: startingrecord
        in: query
        description: Starting index of Records returned. Used when number of Records required exceeds limit on single request. Starts at Index 1
        required: true
        schema:
          type: integer
      - name: ver
        in: query
        description: Always set to 2
        required: true
        schema:
          type: integer
      - name: schema
        in: query
        description: Retrieves schema specific metrics after passing over the corresponding code. Returns WoS categories if absent.
        examples:
          Search1:
            value: anvur
            summary: ANVUR
          Search2:
            value: for1
            summary: Australia ERA 2018 FOR Level 1
          Search3:
            value: for2
            summary: Australia ERA 2018 FOR Level 2
          Search4:
            value: capesl1
            summary: CAPES Level 1
          Search5:
            value: capesl2
            summary: CAPES Level 2
          Search6:
            value: capesl3
            summary: CAPES Level 3
          Search7:
            value: scadcl1
            summary: China SCADC Subject Categories 12 Broad levels
          Search8:
            value: scadcl2
            summary: China SCADC Subject Categories 77 Narrow levels
          Search9:
            value: ct
            summary: Citation Topics
          Search10:
            value: et
            summary: Emerging Topics
          Search11:
            value: esi
            summary: Essential Science Indicators
          Search12:
            value: fapesp
            summary: FAPESP
          Search13:
            value: gipp
            summary: GIPP
          Search14:
            value: kakenl2
            summary: KAKEN Level 2
          Search15:
            value: kakenl3
            summary: KAKEN Level 3
          Search16:
            value: oecd
            summary: OECD
          Search17:
            value: pl19
            summary: Polish classification of disciplines
          Search18:
            value: ris3
            summary: Research and Innovation Strategies for Specialization (RIS3)
          Search19:
            value: ref2008
            summary: UK REF 2008
          Search20:
            value: ref2014
            summary: UK REF 2014
          Search21:
            value: ref2021
            summary: UK REF 2021
          Search22:
            value: sdg
            summary: UN Sustainable Development Goals
          Search23:
            value: gras
            summary: Shanghai GRAS ranking
          Search24:
            value: wos
            summary: Web of Science
        schema:
          type: string
          default: wos
      - name: esci
        in: query
        description: Flag to return InCites baseline metrics with Emerging Sources Citation Index (ESCI) content. Accepts y/n case insensitive values only. y - returns InCites metrics with ESCI index, n - returns InCites metrics without ESCI index
        schema:
          type: string
          default: n
      responses:
        '200':
          description: Success
          content:
            application/xml:
              example: "<?xml version='1.0' encoding='UTF-8' ?>\n<response xmlns='http://www.isinet.com/xrpc42'>\n\t<fn name='IncitesWebServices.getDocumentLevelMetricsByUT' rc='OK'>\n\t\t<list>\n\t\t\t<map>\n\t\t\t\t<val name='ACCESSION_NUMBER'>000077675600082</val>\n\t\t\t\t<val name='DOCUMENT_TYPE'>ARTICLE</val>\n\t\t\t\t<val name='TIMES_CITED'>0</val>\n\t\t\t\t<val name='IMPACT_FACTOR'>-1</val>\n\t\t\t\t<val name='HARMEAN_CAT_EXP_CITATION'>1.1968</val>\n\t\t\t\t<val name='JNCI'>2.49</val>\n\t\t\t\t<val name='AVG_CNCI'>0</val>\n\t\t\t\t<val name='ESI_HIGHLY_CITED_PAPER'>0</val>\n\t\t\t\t<val name='ESI_HOT_PAPER'>0</val>\n\t\t\t\t<val name='IS_INTERNATIONAL_COLLAB'>0</val>\n\t\t\t\t<val name='IS_INSTITUTION_COLLAB'>0</val>\n\t\t\t\t<val name='IS_INDUSTRY_COLLAB'>0</val>\n\t\t\t\t<val name='RNUM'>1</val>\n\t\t\t\t<list name='PERCENTILE'>\n\t\t\t\t\t<map>\n\t\t\t\t\t\t<val name='SUBJECT'>ONCOLOGY</val>\n\t\t\t\t\t\t<val name='CODE'>MR</val>\n\t\t\t\t\t\t<val name='CAT_PERC'>5.26</val>\n\t\t\t\t\t\t<val name='IS_BEST'>true</val>\n\t\t\t\t\t\t<val name='CNCI'>8.2231</val>\n\t\t\t\t\t\t<val name='CAT_EXP_CITATION'>13.694358825683594</val>\n\t\t\t\t\t</map>\n\t\t\t\t\t<map>\n\t\t\t\t\t\t<val name='SUBJECT'>ECONOMICS</val>\n\t\t\t\t\t\t<val name='CODE'>GY</val>\n\t\t\t\t\t\t<val name='CAT_PERC'>73.45</val>\n\t\t\t\t\t\t<val name='IS_BEST'>false</val>\n\t\t\t\t\t\t<val name='CNCI'>9.4199</val>\n\t\t\t\t\t\t<val name='CAT_EXP_CITATION'>29.480670928955078</val>\n\t\t\t\t\t</map>\n\t\t\t\t</list>\n\t\t\t\t<map name='OPEN_ACCESS'>\n\t\t\t\t\t<val name='OA_FLAG'>1</val>\n\t\t\t\t\t<list name='STATUS'>\n\t\t\t\t\t\t<map>\n\t\t\t\t\t\t\t<val name='TYPE'>GREEN PUBLISHED</val>\n\t\t\t\t\t\t</map>\n\t\t\t\t\t\t<map>\n\t\t\t\t\t\t\t<val name='TYPE'>OTHER GOLD</val> \n\t\t\t\t\t\t</map>\n\t\t\t\t\t</list>\n\t\t\t\t</map>\n\t\t\t</map>\n\t\t</list>\n\t</fn>\n</response>"
        '400':
          description: Bad request
          content: {}
        '500':
          description: Internal server error
          content: {}
      operationId: getDocumentLevelMetricsByInstitutionIdXml
      x-operation-id-source: derived
  /DocumentLevelMetricsByInstitutionIdRecordCount/xml:
    get:
      tags:
      - XML
      summary: Get metrics count by year
      description: Input a year, and InCites API returns number of records unified to your institution. Used in conjunction with DocumentLevelMetricsByInstitutionId
      parameters:
      - name: X-ApiKey
        in: header
        description: Developer Key parameter, authenticates you to use the service and ties your institution id to the call. Previous versions of this API supported this as a query parameter with the key 'X-TR-API-APP-ID'. This construct will be supported for a time, but going forward, this parameter should be passed in the header
        required: true
        schema:
          type: string
      - name: year
        in: query
        description: Your response will contain records published starting in this year. Must be at least 1980
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/xml:
              schema:
                type: integer
              example: "<?xml version='1.0' encoding='UTF-8' ?>\n<response xmlns='http://www.isinet.com/xrpc42'>\n\t<fn name='IncitesWebServices.getNumPublicationsByInstitutionId' rc='OK'>\n\t\t<val>22922</val>\n\t</fn>\n</response>"
        '400':
          description: Bad request
          content: {}
        '500':
          description: Internal server error
          content: {}
      operationId: getDocumentLevelMetricsByInstitutionIdRecordCountXml
      x-operation-id-source: derived
  /DocumentLevelMetricsByUT/xml:
    get:
      tags:
      - XML
      summary: Get metrics by UT
      description: Find document level metrics for a given UT
      parameters:
      - name: X-ApiKey
        in: header
        description: Developer Key parameter, authenticates you to use the service and ties your institution id to the call. Previous versions of this API supported this as a query parameter with the key 'X-TR-API-APP-ID'. This construct will be supported for a time, but going forward, this parameter should be passed in the header
        required: true
        schema:
          type: string
      - name: UT
        in: query
        description: Submit a comma delimited list of UT values and get InCites metrics in the response. A valid UT is 15 alphanumeric digits. All trailing 0's must be left in the UT, and there should be no spaces between UTs. If there is no data for a UT or an invalid UT is entered, that UT will be ignored in the response. A limit of 100 UTs may be submitted per request. To see sample API results, use one or more of the following UTs 000352040700014,000353267900023,000346982900018,000346342200004
        required: true
        schema:
          type: string
      - name: ver
        in: query
        description: Always set to 2
        required: true
        schema:
          type: integer
      - name: schema
        in: query
        description: Retrieves schema specific metrics after passing over the corresponding code. Returns WoS categories if absent.
        examples:
          Search1:
            value: anvur
            summary: ANVUR
          Search2:
            value: for1
            summary: Australia ERA 2018 FOR Level 1
          Search3:
            value: for2
            summary: Australia ERA 2018 FOR Level 2
          Search4:
            value: capesl1
            summary: CAPES Level 1
          Search5:
            value: capesl2
            summary: CAPES Level 2
          Search6:
            value: capesl3
            summary: CAPES Level 3
          Search7:
            value: scadcl1
            summary: China SCADC Subject Categories 12 Broad levels
          Search8:
            value: scadcl2
            summary: China SCADC Subject Categories 77 Narrow levels
          Search9:
            value: ct
            summary: Citation Topics
          Search10:
            value: et
            summary: Emerging Topics
          Search11:
            value: esi
            summary: Essential Science Indicators
          Search12:
            value: fapesp
            summary: FAPESP
          Search13:
            value: gipp
            summary: GIPP
          Search14:
            value: kakenl2
            summary: KAKEN Level 2
          Search15:
            value: kakenl3
            summary: KAKEN Level 3
          Search16:
            value: oecd
            summary: OECD
          Search17:
            value: pl19
            summary: Polish classification of disciplines
          Search18:
            value: ris3
            summary: Research and Innovation Strategies for Specialization (RIS3)
          Search19:
            value: ref2008
            summary: UK REF 2008
          Search20:
            value: ref2014
            summary: UK REF 2014
          Search21:
            value: ref2021
            summary: UK REF 2021
          Search22:
            value: sdg
            summary: UN Sustainable Development Goals
          Search23:
            value: gras
            summary: Shanghai GRAS ranking
          Search24:
            value: wos
            summary: Web of Science
        schema:
          type: string
          default: wos
      - name: esci
        in: query
        description: Flag to return InCites baseline metrics with Emerging Sources Citation Index (ESCI) content. Accepts y/n case insensitive values only. y - returns InCites metrics with ESCI index, n - returns InCites metrics without ESCI index
        schema:
          type: string
          default: n
      responses:
        '200':
          description: Success
          content:
            application/xml:
              example: "<?xml version='1.0' encoding='UTF-8' ?>\n<response xmlns='http://www.isinet.com/xrpc42'>\n\t<fn name='IncitesWebServices.getDocumentLevelMetricsByUT' rc='OK'>\n\t\t<list>\n\t\t\t<map>\n\t\t\t\t<val name='ACCESSION_NUMBER'>000077675600082</val>\n\t\t\t\t<val name='DOCUMENT_TYPE'>ARTICLE</val>\n\t\t\t\t<val name='TIMES_CITED'>0</val>\n\t\t\t\t<val name='IMPACT_FACTOR'>-1</val>\n\t\t\t\t<val name='HARMEAN_CAT_EXP_CITATION'>1.1968</val>\n\t\t\t\t<val name='JNCI'>2.49</val>\n\t\t\t\t<val name='AVG_CNCI'>0</val>\n\t\t\t\t<val name='ESI_HIGHLY_CITED_PAPER'>0</val>\n\t\t\t\t<val name='ESI_HOT_PAPER'>0</val>\n\t\t\t\t<val name='IS_INTERNATIONAL_COLLAB'>0</val>\n\t\t\t\t<val name='IS_INSTITUTION_COLLAB'>0</val>\n\t\t\t\t<val name='IS_INDUSTRY_COLLAB'>0</val>\n\t\t\t\t<val name='RNUM'>1</val>\n\t\t\t\t<list name='PERCENTILE'>\n\t\t\t\t\t<map>\n\t\t\t\t\t\t<val name='SUBJECT'>ONCOLOGY</val>\n\t\t\t\t\t\t<val name='CODE'>MR</val>\n\t\t\t\t\t\t<val name='CAT_PERC'>5.26</val>\n\t\t\t\t\t\t<val name='IS_BEST'>true</val>\n\t\t\t\t\t\t<val name='CNCI'>8.2231</val>\n\t\t\t\t\t\t<val name='CAT_EXP_CITATION'>13.694358825683594</val>\n\t\t\t\t\t</map>\n\t\t\t\t\t<map>\n\t\t\t\t\t\t<val name='SUBJECT'>ECONOMICS</val>\n\t\t\t\t\t\t<val name='CODE'>GY</val>\n\t\t\t\t\t\t<val name='CAT_PERC'>73.45</val>\n\t\t\t\t\t\t<val name='IS_BEST'>false</val>\n\t\t\t\t\t\t<val name='CNCI'>9.4199</val>\n\t\t\t\t\t\t<val name='CAT_EXP_CITATION'>29.480670928955078</val>\n\t\t\t\t\t</map>\n\t\t\t\t</list>\n\t\t\t\t<map name='OPEN_ACCESS'>\n\t\t\t\t\t<val name='OA_FLAG'>1</val>\n\t\t\t\t\t<list name='STATUS'>\n\t\t\t\t\t\t<map>\n\t\t\t\t\t\t\t<val name='TYPE'>GREEN PUBLISHED</val>\n\t\t\t\t\t\t</map>\n\t\t\t\t\t\t<map>\n\t\t\t\t\t\t\t<val name='TYPE'>OTHER GOLD</val> \n\t\t\t\t\t\t</map>\n\t\t\t\t\t</list>\n\t\t\t\t</map>\n\t\t\t</map>\n\t\t</list>\n\t</fn>\n</response>"
        '400':
          description: Bad request
          content: {}
        '500':
          description: Internal server error
          content: {}
      operationId: getDocumentLevelMetricsByUTXml
      x-operation-id-source: derived
  /CheckValidUTs/xml:
    get:
      tags:
      - XML
      summary: Get invalid UTs
      description: Find invalid UT(s) from a given list of UTs
      parameters:
      - name: X-ApiKey
        in: header
        description: Developer Key parameter, authenticates you to use the service and ties your institution id to the call. Previous versions of this API supported this as a query parameter with the key 'X-TR-API-APP-ID'. This construct will be supported for a time, but going forward, this parameter should be passed in the header
        required: true
        schema:
          type: string
      - name: UT
        in: query
        description: Submit a comma delimited list of UT values and get InCites metrics in the response. A valid UT is 15 alphanumeric digits. All trailing 0's must be left in the UT, and there should be no spaces between UTs. If there is no data for a UT or an invalid UT is entered, that UT will be ignored in the response. A limit of 100 UTs may be submitted per request. To see sample API results, use one or more of the following UTs 000352040700014,000353267900023,000346982900018,000346342200004
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/xml:
              example: "<?xml version='1.0' encoding='UTF-8' ?>\n<response xmlns='http://www.isinet.com/xrpc42'>\n\t<fn name='IncitesWebServices.getInvalidUTsList' rc='OK'>\n\t\t<list>\n\t\t\t<map>\n\t\t\t\t<val name='ISI_LOC'>test1</val>\n\t\t\t</map>\n\t\t\t<map>\n\t\t\t\t<val name='ISI_LOC'>test</val>\n\t\t\t</map>\n\t\t</list>\n\t</fn>\n</response>"
        '400':
          description: Bad request
          content: {}
        '500':
          description: Internal server error
          content: {}
      operationId: getCheckValidUTsXml
      x-operation-id-source: derived
  /InCitesLastUpdated/xml:
    get:
      tags:
      - XML
      summary: Get last updated information
      description: Find out incites data set and wos data set index last update time
      parameters:
      - name: X-ApiKey
        in: header
        description: Developer Key parameter, authenticates you to use the service and ties your institution id to the call. Previous versions of this API supported this as a query parameter with the key 'X-TR-API-APP-ID'. This construct will be supported for a time, but going forward, this parameter should be passed in the header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/xml:
              example: "<?xml version='1.0' encoding='UTF-8' ?>\n<response xmlns='http://www.isinet.com/xrpc42'>\n\t<fn name='IncitesWebServices.getInCitesDates' rc='OK'>\n\t\t<list>\n\t\t\t<map>\n\t\t\t\t<val name='INCITES_DATASET_UPDATED'>10-06-2017</val>\n\t\t\t\t<val name='WOS_DATASET_INDEXED'>31/Aug/2017</val>\n\t\t\t</map>\n\t\t</list>\n\t</fn>\n</response>"
        '500':
          description: Internal server error
          content: {}
      operationId: getInCitesLastUpdatedXml
      x-operation-id-source: derived
components:
  securitySchemes:
    key:
      type: apiKey
      in: header
      name: X-ApiKey
x-provenance:
  method: harvested
  publisher: Clarivate
  source: https://developer.clarivate.com/apis/incites/swagger
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)

Clarivate XML API

Operations 5

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification