This API provides journal-level metadata and metrics for all journals in the Journal Citation Reports™ covered in the Web of Science Core Collection, including the Journal Impact Factor™ and other new metrics. Integrate journal data into your internal systems or retrieve journal indicators for bibliometrics studies.
This API follows the REST approach to disclose resources in URL format. Only the GET method is currently available to perform requests over HTTP.
The API is available on the Clarivate Developer Portal. The access requires registration on the Portal and approval from the Clarivate Sales/Product teams to entitle to the API.
All requests require authentication with an API Key authentication flow. For more details, check the Guide.
The current languages/frameworks are supported: Python | Java | Javascript
You can learn more about content at Journal Citation Reports™ Product page, or in the documentation.
This API supports free-text search for a journal name, abbreviation, ISSN code, publisher, and Web of Science™ category name (only /categories
endpoint). You need to provide a complete and valid ISSN code pattern; otherwise, the API will not look up for ISSN codes.
Operator | Description | Example |
---|---|---|
+ / " " | Search by two or more terms in the same field. Blank space is the same as an AND operator. The search retrieves all the records that contain the terms, e.g., | /journals?q=matrix biology /journals?q=nature+group |
OR | Search by at least one term in the field. The search retrieves all the records that contain one of the terms, e.g., | /journals?q=gas OR oil |
NOT / - | Search by excluding specific terms. The search retrieves all the records that match the query specifics, e.g., | /journals?q=genetics -nature |
The wildcards ( * ) are allowed in the search that starts with the search query: /journals?q=nano*
will search indications that start from nano: for example, Nanotechnology or nanotubes.
Please note: the free text search query (with the parameter q=
) should contain at least three symbols.
The API supports several filters for Journals and Web of Science™ Categories, narrowing down the initial list of entities or search results.
There are two types of filters:
- Filter by one or multiple values: edition, categoryCode, jcrYear, jifQuartile
- Filter by range: jif, jifPercentile, jci,
The filter name goes before the equals sign, followed by one or multiple filter values, separated by a semicolon, like categoryCode=RZ;RU
. You can combine various filters with or without the search. Filters are separated by an ampersand (&): q=nature&categoryCode=RU;KM&jcrYear=2018
Please note: filter by jcrYear allows only one year value as an input
The API supports range filtering for Journal Impact Factor (jif) or Journal Impact Factor Percentile (jifPercentile) with the following operators:
- eq (equal): if a Journal Impact Factor (Percentile) is equal to a specific number.
For example: forjif=eq:5.032
the result will include journals with Journal Impact Factor = 5.032.
Not combinable with any other operator - gt (greater than): if a Journal Impact Factor (Percentile) is greater than a specific number.
For example: forjif=gt:5
the result will include journals with Journal Impact Factor = 5.001 and higher.
Combinable with lt and lte operators - gte (greater than equal): if a Journal Impact Factor (Percentile) is greater than or equal to a specific number.
For example: forjif=gte:5
the result will include journals with Journal Impact Factor = 5.000 and higher.
Combinable with lt and lte operators - lt (less than): if a Journal Impact Factor (Percentile) is less than a specific number.
For example: forjif=lt:5
the result will include journals with Journal Impact Factor = 4.999 and less.
Combinable with gt and gte operators - lte (less than equal): if a Journal Impact Factor (Percentile) is less than a specific number.
For example: forjif=lte:5
the result will include journals with Journal Impact Factor = 5.000 and less.
Combinable with gt and gte operators
Use AND
to combine two operators, e.g.,jifPercentile=gte:50 AND lte:80
responses with all journals in a percentile range from 50% to 80% (both included).
To ensure fast response time, each search or multiple entity calls (such as /journals
or /categories/ID/cited/year/YYYY
) retrieve only a certain number of hits/records.
There are two optional request parameters to browse along with the result: limit and page.
- limit: Number of returned results, ranging from 0 to 50 (default 10)
- page: Specifying a page to retrieve (default 1)
Moreover, this information is shown in the response body, in the tag metadata:
\"metadata\": {
\"total\": 91,
\"page\": 1,
\"limit\": 10
}
The WoS Journals API uses conventional HTTP success or failure status codes. For errors, some extra information is included to indicate what went wrong in the JSON response. The list of HTTP codes is listed below.
Code | Title | Description |
---|---|---|
400 | Bad request | Request syntax error |
401 | Unauthorized | The API key is invalid or missed |
404 | Not found | The resource is not found |
405 | Method not allowed | Method other than GET is not allowed |
50X | Server errors | Technical error with servers |
Each error response (except 401 Unauthorized error) contains the code of the error, the title of the error and detailed description of the error: a misprint in an endpoint, wrong URL parameter, etc. The example of the error message is shown below: |
\"error\": {
\"status\": 404,
\"title\": \"Resource couldn't be found\",
\"details\": \"There is no information in WoS Journals API about the identifier ABC_DEF for the Journals content area. Sorry :(\"
}
For the 401 Unauthorized
error the response body is a little bit different:
{
\"error_description\": \"The access token is missing\",
\"error\": \"invalid_request\"
}
This SDK is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
For Node.js
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install clarivate-wos-journals-js-client --save
Finally, you need to build the module:
npm run build
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json
(and this README). Let's call this JAVASCRIPT_CLIENT_DIR
. Then run:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
To use the link you just defined in your project, switch to the directory you want to use your clarivate-wos-journals-js-client from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
Finally, you need to build the module:
npm run build
If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:
npm install GIT_USER_ID/GIT_REPO_ID --save
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify
,
perform the following (assuming main.js is your entry file):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Please follow the installation instruction and execute the following JS code:
var ClarivateWosJournalsJsClient = require('clarivate-wos-journals-js-client');
var api = new ClarivateWosJournalsJsClient.CategoriesApi()
var opts = {
'q': "q_example", // {String} Free-text search by category name. Search logic is described in the section [Search](#search).
'edition': "edition_example", // {String} Filter by Web of Sceince Citation Index. The following indexes (editions) are presented: - SCIE - Science Citation Index Expanded (ournals across more than 170 disciplines) - SSCI - Social Sciences Citation Index (journals across more than 50 social science disciplines) Multiple values are allowed, separated by semicolon ( **;** )
'jcrYear': 56, // {Number} Filter by Category Citation Report year (from 2003). Only one value is allowed.
'page': 1, // {Number} Specifying a page to retrieve
'limit': 10 // {Number} Number of returned results, ranging from 0 to 50
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.categoriesGet(opts, callback);
All URIs are relative to http://wos-journals-snapshot.cortellis.int.clarivate.com
Class | Method | HTTP request | Description |
---|---|---|---|
ClarivateWosJournalsJsClient.CategoriesApi | categoriesGet | GET /categories | Search and filter across the journal categories |
ClarivateWosJournalsJsClient.CategoriesApi | categoriesIdCitedYearYearGet | GET /categories/{id}/cited/year/{year} | Get journals that cite all journals in the category for the JCR year |
ClarivateWosJournalsJsClient.CategoriesApi | categoriesIdCitingYearYearGet | GET /categories/{id}/citing/year/{year} | Get journals that were cited by all journals from the category for the JCR year |
ClarivateWosJournalsJsClient.CategoriesApi | categoriesIdGet | GET /categories/{id} | Get a category |
ClarivateWosJournalsJsClient.CategoriesApi | categoriesIdReportsYearYearGet | GET /categories/{id}/reports/year/{year} | Get category metrics for a year |
ClarivateWosJournalsJsClient.JournalsApi | journalsGet | GET /journals | Search and filter across JCR Journals |
ClarivateWosJournalsJsClient.JournalsApi | journalsIdCitedYearYearGet | GET /journals/{id}/cited/year/{year} | Get journals that cite the journal for the JCR year |
ClarivateWosJournalsJsClient.JournalsApi | journalsIdCitingYearYearGet | GET /journals/{id}/citing/year/{year} | Get journals that were cited by the journal for the JCR year |
ClarivateWosJournalsJsClient.JournalsApi | journalsIdGet | GET /journals/{id} | Get journal by id |
ClarivateWosJournalsJsClient.JournalsApi | journalsIdHistoryGet | GET /journals/{id}/history | Get journal history by id |
ClarivateWosJournalsJsClient.JournalsApi | journalsIdReportsYearYearGet | GET /journals/{id}/reports/year/{year} | Get journal metrics for a year |
- ClarivateWosJournalsJsClient.CategoriesCited
- ClarivateWosJournalsJsClient.CategoriesCitedHits
- ClarivateWosJournalsJsClient.CategoriesCitedJournal
- ClarivateWosJournalsJsClient.CategoriesCiting
- ClarivateWosJournalsJsClient.CategoriesCitingHits
- ClarivateWosJournalsJsClient.CategoriesCitingJournal
- ClarivateWosJournalsJsClient.CategoryData
- ClarivateWosJournalsJsClient.CategoryList
- ClarivateWosJournalsJsClient.CategoryListRecord
- ClarivateWosJournalsJsClient.CategoryRecord
- ClarivateWosJournalsJsClient.CategoryReports
- ClarivateWosJournalsJsClient.CategoryReportsJournals
- ClarivateWosJournalsJsClient.CategoryReportsSourceData
- ClarivateWosJournalsJsClient.CategoryReportsSourceDataArticles
- ClarivateWosJournalsJsClient.CategoryReportsSourceDataReviews
- ClarivateWosJournalsJsClient.CitedData
- ClarivateWosJournalsJsClient.CitingData
- ClarivateWosJournalsJsClient.Frequency
- ClarivateWosJournalsJsClient.HalfLife
- ClarivateWosJournalsJsClient.Immediacy
- ClarivateWosJournalsJsClient.ImpactMetrics
- ClarivateWosJournalsJsClient.InfluenceMetrics
- ClarivateWosJournalsJsClient.InfluenceMetricsEigenFactor
- ClarivateWosJournalsJsClient.Jif
- ClarivateWosJournalsJsClient.JifAggregate
- ClarivateWosJournalsJsClient.JournalData
- ClarivateWosJournalsJsClient.JournalHistoryRecord
- ClarivateWosJournalsJsClient.JournalHistoryRecordIsoTitle
- ClarivateWosJournalsJsClient.JournalHistoryRecordIssn
- ClarivateWosJournalsJsClient.JournalHistoryRecordName
- ClarivateWosJournalsJsClient.JournalHistoryRecordPublisher
- ClarivateWosJournalsJsClient.JournalHistoryRecordPublisher1
- ClarivateWosJournalsJsClient.JournalHistoryRecordYear
- ClarivateWosJournalsJsClient.JournalHistoryRecordYear1
- ClarivateWosJournalsJsClient.JournalHistoryRecordYear2
- ClarivateWosJournalsJsClient.JournalHistoryRecordYear3
- ClarivateWosJournalsJsClient.JournalList
- ClarivateWosJournalsJsClient.JournalListRecord
- ClarivateWosJournalsJsClient.JournalListRecordJournalCitationReports
- ClarivateWosJournalsJsClient.JournalListRecordMetrics
- ClarivateWosJournalsJsClient.JournalListRecordMetricsImpactMetrics
- ClarivateWosJournalsJsClient.JournalListRecordMetricsSourceMetrics
- ClarivateWosJournalsJsClient.JournalListRecordRanks
- ClarivateWosJournalsJsClient.JournalListRecordRanksJci
- ClarivateWosJournalsJsClient.JournalListRecordRanksJif
- ClarivateWosJournalsJsClient.JournalProfile
- ClarivateWosJournalsJsClient.JournalProfileCitableItems
- ClarivateWosJournalsJsClient.JournalProfileCitations
- ClarivateWosJournalsJsClient.JournalProfileOccurrenceCountries
- ClarivateWosJournalsJsClient.JournalProfileOccurrenceOrganizations
- ClarivateWosJournalsJsClient.JournalRecord
- ClarivateWosJournalsJsClient.JournalReports
- ClarivateWosJournalsJsClient.JournalReportsJournal
- ClarivateWosJournalsJsClient.JournalReportsMetrics
- ClarivateWosJournalsJsClient.JournalsCited
- ClarivateWosJournalsJsClient.JournalsCitedHits
- ClarivateWosJournalsJsClient.JournalsCitesJournal
- ClarivateWosJournalsJsClient.JournalsCiting
- ClarivateWosJournalsJsClient.JournalsCitingHits
- ClarivateWosJournalsJsClient.Metadata
- ClarivateWosJournalsJsClient.OpenAccess
- ClarivateWosJournalsJsClient.Publisher
- ClarivateWosJournalsJsClient.RankQuartileData
- ClarivateWosJournalsJsClient.Ranks
- ClarivateWosJournalsJsClient.RanksEsiCitations
- ClarivateWosJournalsJsClient.RanksJif
- ClarivateWosJournalsJsClient.SearchMatch
- ClarivateWosJournalsJsClient.SourceData
- ClarivateWosJournalsJsClient.SourceDataArticles
- ClarivateWosJournalsJsClient.SourceMetrics
- ClarivateWosJournalsJsClient.SourceMetricsCitableItems
All endpoints do not require authorization.