├── test ├── __init__.py ├── test_cites.py ├── test_metadata.py ├── test_half_life.py ├── test_ranks_jif.py ├── test_cited_data.py ├── test_frequency.py ├── test_immediacy.py ├── test_publisher.py ├── test_categories.py ├── test_citing_data.py ├── test_open_access.py ├── test_search_match.py ├── test_jif_aggregate.py ├── test_impact_metrics.py ├── test_rank_quartile_data.py ├── test_ranks_esi_citations.py ├── test_jif.py └── test_source_data_articles.py ├── clarivate ├── __init__.py └── wos_journals │ ├── __init__.py │ └── client │ ├── api │ └── __init__.py │ ├── model │ └── __init__.py │ ├── apis │ └── __init__.py │ ├── models │ └── __init__.py │ └── __init__.py ├── .openapi-generator └── VERSION ├── test-requirements.txt ├── setup.cfg ├── requirements.txt ├── tox.ini ├── .travis.yml ├── docs ├── Cites.md ├── CategoryCitationReports.md ├── Categories.md ├── JournalCitationReport.md ├── HalfLife.md ├── Jif.md ├── JournalsCitesJournal.md ├── SourceDataArticles.md ├── CategoryReportsJournals.md ├── SourceMetricsCitableItems.md ├── CategoryData.md ├── JournalListRecordMetricsSourceMetrics.md ├── JournalHistoryRecordYear.md ├── RanksEsiCitations.md ├── CitedData.md ├── JournalHistoryRecordYear1.md ├── JournalHistoryRecordYear3.md ├── JournalList.md ├── CitingData.md ├── Immediacy.md ├── JournalsCited.md ├── JournalsCiting.md ├── CategoriesCited.md ├── CategoriesCitedJournal.md ├── CategoriesCitingJournal.md ├── JournalsCitedHits.md ├── JournalsCitingHits.md ├── CategoriesCiting.md ├── JournalHistoryRecordName.md ├── CategoriesCitedHits.md ├── CategoriesCitingHits.md ├── CategoryList.md ├── JournalHistoryRecordIssn.md ├── JournalListRecordMetricsImpactMetrics.md ├── JournalHistoryRecordIsoTitle.md ├── JournalListRecordJournalCitationReports.md ├── CategoryReportsSourceDataArticles.md ├── CategoryReportsSourceDataReviews.md ├── OpenAccess.md ├── JournalHistoryRecordYear2.md ├── JournalData.md ├── JournalListRecordRanksJci.md ├── JournalProfileOccurrenceCountries.md ├── JournalProfileOccurrenceOrganizations.md ├── JournalHistoryRecordPublisher.md ├── RankQuartileData.md ├── SearchMatch.md ├── JournalHistoryRecordPublisher1.md ├── JournalListRecordRanksJif.md ├── RanksJif.md ├── JifAggregate.md ├── JournalReportsJournal.md ├── JournalListRecordRanks.md ├── Publisher.md ├── InfluenceMetrics.md ├── JournalProfileCitableItems.md ├── Metadata.md ├── JournalProfileCitations.md ├── JournalListRecordMetrics.md ├── SourceMetrics.md ├── CategoryRecord.md ├── JournalReportsMetrics.md ├── CategoryReportsSourceData.md ├── SourceData.md ├── CategoryListRecord.md ├── JournalHistoryRecord.md ├── Frequency.md ├── CategoryReports.md ├── Ranks.md ├── InfluenceMetricsEigenFactor.md ├── JournalReports.md ├── JournalListRecord.md ├── JournalProfile.md ├── ImpactMetrics.md └── JournalRecord.md ├── .gitlab-ci.yml ├── .gitignore ├── .openapi-generator-ignore ├── git_push.sh └── example.py /test/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /clarivate/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.openapi-generator/VERSION: -------------------------------------------------------------------------------- 1 | 5.4.0 -------------------------------------------------------------------------------- /clarivate/wos_journals/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /test-requirements.txt: -------------------------------------------------------------------------------- 1 | pytest-cov>=2.8.1 2 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [flake8] 2 | max-line-length=99 3 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | python_dateutil >= 2.5.3 2 | setuptools >= 21.0.0 3 | urllib3 >= 1.25.3 4 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | [tox] 2 | envlist = py3 3 | 4 | [testenv] 5 | deps=-r{toxinidir}/requirements.txt 6 | -r{toxinidir}/test-requirements.txt 7 | 8 | commands= 9 | pytest --cov=clarivate.wos_journals.client 10 | -------------------------------------------------------------------------------- /clarivate/wos_journals/client/api/__init__.py: -------------------------------------------------------------------------------- 1 | # do not import all apis into this module because that uses a lot of memory and stack frames 2 | # if you need the ability to import all apis from one package, import them with 3 | # from clarivate.wos_journals.client.apis import CategoriesApi 4 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | # ref: https://docs.travis-ci.com/user/languages/python 2 | language: python 3 | python: 4 | - "3.6" 5 | - "3.7" 6 | - "3.8" 7 | - "3.9" 8 | # command to install dependencies 9 | install: 10 | - "pip install -r requirements.txt" 11 | - "pip install -r test-requirements.txt" 12 | # command to run tests 13 | script: pytest --cov=clarivate.wos_journals.client 14 | -------------------------------------------------------------------------------- /clarivate/wos_journals/client/model/__init__.py: -------------------------------------------------------------------------------- 1 | # we can not import model classes here because that would create a circular 2 | # reference which would not work in python2 3 | # do not import all models into this module because that uses a lot of memory and stack frames 4 | # if you need the ability to import all models from one package, import them with 5 | # from {{packageName}.models import ModelA, ModelB 6 | -------------------------------------------------------------------------------- /docs/Cites.md: -------------------------------------------------------------------------------- 1 | # Cites 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **value** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CategoryCitationReports.md: -------------------------------------------------------------------------------- 1 | # CategoryCitationReports 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **value** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /.gitlab-ci.yml: -------------------------------------------------------------------------------- 1 | # ref: https://docs.gitlab.com/ee/ci/README.html 2 | 3 | stages: 4 | - test 5 | 6 | .tests: 7 | stage: test 8 | script: 9 | - pip install -r requirements.txt 10 | - pip install -r test-requirements.txt 11 | - pytest --cov=clarivate.wos_journals.client 12 | 13 | test-3.6: 14 | extends: .tests 15 | image: python:3.6-alpine 16 | test-3.7: 17 | extends: .tests 18 | image: python:3.7-alpine 19 | test-3.8: 20 | extends: .tests 21 | image: python:3.8-alpine 22 | test-3.9: 23 | extends: .tests 24 | image: python:3.9-alpine 25 | -------------------------------------------------------------------------------- /docs/Categories.md: -------------------------------------------------------------------------------- 1 | # Categories 2 | 3 | List of journal categories with related editions/databases 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **value** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | List of journal categories with related editions/databases | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/JournalCitationReport.md: -------------------------------------------------------------------------------- 1 | # JournalCitationReport 2 | 3 | List of all available Journal Citation Reports by year 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **value** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | List of all available Journal Citation Reports by year | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/HalfLife.md: -------------------------------------------------------------------------------- 1 | # HalfLife 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **cited** | **float** | | [optional] 8 | **citing** | **float** | | [optional] 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Jif.md: -------------------------------------------------------------------------------- 1 | # Jif 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **median** | **float** | | [optional] 8 | **aggregate** | [**JifAggregate**](JifAggregate.md) | | [optional] 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/JournalsCitesJournal.md: -------------------------------------------------------------------------------- 1 | # JournalsCitesJournal 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **self** | **str** | | [optional] 8 | **name** | **str** | | [optional] 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/SourceDataArticles.md: -------------------------------------------------------------------------------- 1 | # SourceDataArticles 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **count** | **int** | | [optional] 8 | **references** | **int** | | [optional] 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/CategoryReportsJournals.md: -------------------------------------------------------------------------------- 1 | # CategoryReportsJournals 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **count** | **int** | | [optional] 8 | **url** | **str** | | [optional] 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/SourceMetricsCitableItems.md: -------------------------------------------------------------------------------- 1 | # SourceMetricsCitableItems 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **total** | **int** | | [optional] 8 | **articles_percentage** | **float** | | [optional] 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/CategoryData.md: -------------------------------------------------------------------------------- 1 | # CategoryData 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **cited** | [**CitedData**](CitedData.md) | | [optional] 8 | **citing** | [**CitingData**](CitingData.md) | | [optional] 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/JournalListRecordMetricsSourceMetrics.md: -------------------------------------------------------------------------------- 1 | # JournalListRecordMetricsSourceMetrics 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **jif_percentile** | **float** | Journal Impact Factor Percentile | [optional] 8 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/JournalHistoryRecordYear.md: -------------------------------------------------------------------------------- 1 | # JournalHistoryRecordYear 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **start** | **int** | First year of name | [optional] 8 | **end** | **int** | Last year of name | [optional] 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/RanksEsiCitations.md: -------------------------------------------------------------------------------- 1 | # RanksEsiCitations 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **category** | **str** | | [optional] 8 | **rank** | **str** | | [optional] 9 | **quartile** | **str** | | [optional] 10 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/CitedData.md: -------------------------------------------------------------------------------- 1 | # CitedData 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **url** | **str** | Link to the Cited endpoint for the JCR year. | [optional] 8 | **count** | **int** | Number of cited journals | [optional] 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/JournalHistoryRecordYear1.md: -------------------------------------------------------------------------------- 1 | # JournalHistoryRecordYear1 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **start** | **int** | First year of ISSN | [optional] 8 | **end** | **int** | Last year of ISSN | [optional] 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/JournalHistoryRecordYear3.md: -------------------------------------------------------------------------------- 1 | # JournalHistoryRecordYear3 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **start** | **int** | First year of title | [optional] 8 | **end** | **int** | Last year of title | [optional] 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/JournalList.md: -------------------------------------------------------------------------------- 1 | # JournalList 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **metadata** | [**Metadata**](Metadata.md) | | [optional] 8 | **hits** | [**[JournalListRecord]**](JournalListRecord.md) | | [optional] 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/CitingData.md: -------------------------------------------------------------------------------- 1 | # CitingData 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **url** | **str** | Link to the Citing endpoint for the JCR year. | [optional] 8 | **count** | **int** | Number of citing journals | [optional] 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Immediacy.md: -------------------------------------------------------------------------------- 1 | # Immediacy 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **count** | **float** | | [optional] 8 | **cites_current_year** | **int** | | [optional] 9 | **published_current_year** | **int** | | [optional] 10 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/JournalsCited.md: -------------------------------------------------------------------------------- 1 | # JournalsCited 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **metadata** | [**Metadata**](Metadata.md) | | [optional] 8 | **hits** | [**[JournalsCitedHits]**](JournalsCitedHits.md) | | [optional] 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/JournalsCiting.md: -------------------------------------------------------------------------------- 1 | # JournalsCiting 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **metadata** | [**Metadata**](Metadata.md) | | [optional] 8 | **hits** | [**[JournalsCitingHits]**](JournalsCitingHits.md) | | [optional] 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/CategoriesCited.md: -------------------------------------------------------------------------------- 1 | # CategoriesCited 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **metadata** | [**Metadata**](Metadata.md) | | [optional] 8 | **hits** | [**[CategoriesCitedHits]**](CategoriesCitedHits.md) | | [optional] 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/CategoriesCitedJournal.md: -------------------------------------------------------------------------------- 1 | # CategoriesCitedJournal 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **self** | **str** | | [optional] 8 | **name** | **str** | | [optional] 9 | **cited_journals** | **int** | | [optional] 10 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/CategoriesCitingJournal.md: -------------------------------------------------------------------------------- 1 | # CategoriesCitingJournal 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **self** | **str** | | [optional] 8 | **name** | **str** | | [optional] 9 | **citing_journals** | **int** | | [optional] 10 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/JournalsCitedHits.md: -------------------------------------------------------------------------------- 1 | # JournalsCitedHits 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **journal** | [**JournalsCitesJournal**](JournalsCitesJournal.md) | | [optional] 8 | **citing** | [**Cites**](Cites.md) | | [optional] 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/JournalsCitingHits.md: -------------------------------------------------------------------------------- 1 | # JournalsCitingHits 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **journal** | [**JournalsCitesJournal**](JournalsCitesJournal.md) | | [optional] 8 | **cited** | [**Cites**](Cites.md) | | [optional] 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/CategoriesCiting.md: -------------------------------------------------------------------------------- 1 | # CategoriesCiting 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **metadata** | [**Metadata**](Metadata.md) | | [optional] 8 | **hits** | [**[CategoriesCitingHits]**](CategoriesCitingHits.md) | | [optional] 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/JournalHistoryRecordName.md: -------------------------------------------------------------------------------- 1 | # JournalHistoryRecordName 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **str** | Name | [optional] 8 | **year** | [**JournalHistoryRecordYear**](JournalHistoryRecordYear.md) | | [optional] 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /clarivate/wos_journals/client/apis/__init__.py: -------------------------------------------------------------------------------- 1 | 2 | # flake8: noqa 3 | 4 | # Import all APIs into this package. 5 | # If you have many APIs here with many many models used in each API this may 6 | # raise a `RecursionError`. 7 | # In order to avoid this, import only the API that you directly need like: 8 | # 9 | # from .api.categories_api import CategoriesApi 10 | # 11 | # or import this package, but before doing it, use: 12 | # 13 | # import sys 14 | # sys.setrecursionlimit(n) 15 | 16 | # Import APIs into API package: 17 | from clarivate.wos_journals.client.api.categories_api import CategoriesApi 18 | from clarivate.wos_journals.client.api.journals_api import JournalsApi 19 | -------------------------------------------------------------------------------- /docs/CategoriesCitedHits.md: -------------------------------------------------------------------------------- 1 | # CategoriesCitedHits 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **journal** | [**CategoriesCitedJournal**](CategoriesCitedJournal.md) | | [optional] 8 | **citing** | [**Cites**](Cites.md) | | [optional] 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/CategoriesCitingHits.md: -------------------------------------------------------------------------------- 1 | # CategoriesCitingHits 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **journal** | [**CategoriesCitingJournal**](CategoriesCitingJournal.md) | | [optional] 8 | **cited** | [**Cites**](Cites.md) | | [optional] 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/CategoryList.md: -------------------------------------------------------------------------------- 1 | # CategoryList 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **metadata** | [**Metadata**](Metadata.md) | | [optional] 8 | **hits** | [**[CategoryListRecord]**](CategoryListRecord.md) | List of retrieved categories | [optional] 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/JournalHistoryRecordIssn.md: -------------------------------------------------------------------------------- 1 | # JournalHistoryRecordIssn 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **issn** | **str** | ISSN identifier | [optional] 8 | **year** | [**JournalHistoryRecordYear1**](JournalHistoryRecordYear1.md) | | [optional] 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/JournalListRecordMetricsImpactMetrics.md: -------------------------------------------------------------------------------- 1 | # JournalListRecordMetricsImpactMetrics 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **jif** | **str** | Journal Impact Factor | [optional] 8 | **jci** | **str** | Journal Citation Indicator | [optional] 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/JournalHistoryRecordIsoTitle.md: -------------------------------------------------------------------------------- 1 | # JournalHistoryRecordIsoTitle 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **iso_title** | **str** | ISO title | [optional] 8 | **year** | [**JournalHistoryRecordYear3**](JournalHistoryRecordYear3.md) | | [optional] 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/JournalListRecordJournalCitationReports.md: -------------------------------------------------------------------------------- 1 | # JournalListRecordJournalCitationReports 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **year** | **int** | JCR Year (from 1997) | [optional] 8 | **url** | **str** | Link to the related report | [optional] 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/CategoryReportsSourceDataArticles.md: -------------------------------------------------------------------------------- 1 | # CategoryReportsSourceDataArticles 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **count** | **int** | Total count of articles | [optional] 8 | **references** | **int** | Total count of article references | [optional] 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/CategoryReportsSourceDataReviews.md: -------------------------------------------------------------------------------- 1 | # CategoryReportsSourceDataReviews 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **count** | **int** | Total count of reviews | [optional] 8 | **references** | **int** | Total count of review references | [optional] 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/OpenAccess.md: -------------------------------------------------------------------------------- 1 | # OpenAccess 2 | 3 | Journal open access status 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **start_year** | **int** | First year of journal open access | [optional] 9 | **end_year** | **int** | Last year of journal open access | [optional] 10 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/JournalHistoryRecordYear2.md: -------------------------------------------------------------------------------- 1 | # JournalHistoryRecordYear2 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **start** | **int** | First year of name, address, and country/region | [optional] 8 | **end** | **int** | Last year of name, address, and country/region | [optional] 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/JournalData.md: -------------------------------------------------------------------------------- 1 | # JournalData 2 | 3 | Links to the Cited and Citing endpoints, with the total count of records. 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **cited** | [**CitedData**](CitedData.md) | | [optional] 9 | **citing** | [**CitingData**](CitingData.md) | | [optional] 10 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/JournalListRecordRanksJci.md: -------------------------------------------------------------------------------- 1 | # JournalListRecordRanksJci 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **category** | **str** | | [optional] 8 | **rank** | **str** | | [optional] 9 | **quartile** | **str** | | [optional] 10 | **jci_percentile** | **float** | | [optional] 11 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/JournalProfileOccurrenceCountries.md: -------------------------------------------------------------------------------- 1 | # JournalProfileOccurrenceCountries 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **country_region** | **str** | Country/region name | [optional] 8 | **occurrence** | **int** | Number of country/region's articles/reviews/etc | [optional] 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/JournalProfileOccurrenceOrganizations.md: -------------------------------------------------------------------------------- 1 | # JournalProfileOccurrenceOrganizations 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **organization** | **str** | Organization name | [optional] 8 | **occurrence** | **int** | Number of organization's articles/reviews/etc | [optional] 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/JournalHistoryRecordPublisher.md: -------------------------------------------------------------------------------- 1 | # JournalHistoryRecordPublisher 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **str** | Publisher name | [optional] 8 | **address** | **str** | Publisher address | [optional] 9 | **country_region** | **str** | Publisher country/region | [optional] 10 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/RankQuartileData.md: -------------------------------------------------------------------------------- 1 | # RankQuartileData 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **category** | **str** | | [optional] 8 | **edition** | **str** | | [optional] 9 | **self** | **str** | | [optional] 10 | **rank** | **str** | | [optional] 11 | **quartile** | **str** | | [optional] 12 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/SearchMatch.md: -------------------------------------------------------------------------------- 1 | # SearchMatch 2 | 3 | Displays the field and value matched to the search string 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **field** | **str** | Name of the matched field | [optional] 9 | **value** | **[str]** | Array of matched values (if several) with the HTML highligthing | [optional] 10 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/JournalHistoryRecordPublisher1.md: -------------------------------------------------------------------------------- 1 | # JournalHistoryRecordPublisher1 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **publisher** | [**JournalHistoryRecordPublisher**](JournalHistoryRecordPublisher.md) | | [optional] 8 | **year** | [**JournalHistoryRecordYear2**](JournalHistoryRecordYear2.md) | | [optional] 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/JournalListRecordRanksJif.md: -------------------------------------------------------------------------------- 1 | # JournalListRecordRanksJif 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **category** | **str** | | [optional] 8 | **edition** | **str** | | [optional] 9 | **self** | **str** | | [optional] 10 | **rank** | **str** | | [optional] 11 | **quartile** | **str** | | [optional] 12 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/RanksJif.md: -------------------------------------------------------------------------------- 1 | # RanksJif 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **category** | **str** | | [optional] 8 | **edition** | **str** | | [optional] 9 | **self** | **str** | | [optional] 10 | **rank** | **str** | | [optional] 11 | **quartile** | **str** | | [optional] 12 | **jif_percentile** | **float** | | [optional] 13 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/JifAggregate.md: -------------------------------------------------------------------------------- 1 | # JifAggregate 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **count** | **str** | | [optional] 8 | **cites_year_ago** | **int** | | [optional] 9 | **cites_two_years_ago** | **int** | | [optional] 10 | **published_year_ago** | **int** | | [optional] 11 | **published_two_years_ago** | **int** | | [optional] 12 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/JournalReportsJournal.md: -------------------------------------------------------------------------------- 1 | # JournalReportsJournal 2 | 3 | Main information about the report journal 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **id** | **str** | Journal unique identifier | [optional] 9 | **self** | **str** | Journals API link to the journal entity | [optional] 10 | **name** | **str** | Journal title | [optional] 11 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/JournalListRecordRanks.md: -------------------------------------------------------------------------------- 1 | # JournalListRecordRanks 2 | 3 | Journal ranks information (only if the filter \"jifQuartle\" was selected) 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **jif** | [**[JournalListRecordRanksJif]**](JournalListRecordRanksJif.md) | | [optional] 9 | **jci** | [**[JournalListRecordRanksJci]**](JournalListRecordRanksJci.md) | | [optional] 10 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/Publisher.md: -------------------------------------------------------------------------------- 1 | # Publisher 2 | 3 | Information about the journal publisher 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **id** | **str** | Publisher unique identifier | [optional] 9 | **name** | **str** | Publisher name | [optional] 10 | **address** | **str** | Publisher address | [optional] 11 | **country_region** | **str** | Publisher country/region | [optional] 12 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/InfluenceMetrics.md: -------------------------------------------------------------------------------- 1 | # InfluenceMetrics 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **eigen_factor** | [**InfluenceMetricsEigenFactor**](InfluenceMetricsEigenFactor.md) | | [optional] 8 | **article_influence** | **float** | Article influence metrics. For more information, please visit [this page](http://jcr.help.clarivate.com/Content/glossary-article-influence-score.htm) | [optional] 9 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/JournalProfileCitableItems.md: -------------------------------------------------------------------------------- 1 | # JournalProfileCitableItems 2 | 3 | Open access citable items for the three years. Detailed information could be found in [this page](http://jcr.help.clarivate.com/Content/open-access.htm) 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **gold_oa** | **int** | | [optional] 9 | **subscription** | **int** | | [optional] 10 | **other** | **int** | | [optional] 11 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/Metadata.md: -------------------------------------------------------------------------------- 1 | # Metadata 2 | 3 | Information about total number of journals in the retrieve, number of recodrs on the page, and the page number. 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **total** | **int** | Total number of records for the request. | [optional] 9 | **page** | **int** | Page number (default is 1) | [optional] 10 | **limit** | **int** | Number of records on a page (default is 10). | [optional] 11 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/JournalProfileCitations.md: -------------------------------------------------------------------------------- 1 | # JournalProfileCitations 2 | 3 | Open access citations for the three years. Detailed information could be found in [this page](http://jcr.help.clarivate.com/Content/open-access.htm) 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **gold_oa** | **int** | | [optional] 9 | **subscription** | **int** | | [optional] 10 | **other** | **int** | | [optional] 11 | **unlinked** | **int** | | [optional] 12 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/JournalListRecordMetrics.md: -------------------------------------------------------------------------------- 1 | # JournalListRecordMetrics 2 | 3 | Journal metrics information (only if the filter(s) \"jif\" or \"jifPercentile\" were selected) 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **impact_metrics** | [**JournalListRecordMetricsImpactMetrics**](JournalListRecordMetricsImpactMetrics.md) | | [optional] 9 | **source_metrics** | [**JournalListRecordMetricsSourceMetrics**](JournalListRecordMetricsSourceMetrics.md) | | [optional] 10 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/SourceMetrics.md: -------------------------------------------------------------------------------- 1 | # SourceMetrics 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **citable_items** | [**SourceMetricsCitableItems**](SourceMetricsCitableItems.md) | | [optional] 8 | **jif_percentile** | **float** | Average Journal Impact Factor Percentile. Detailed information could be found in [this page](http://jcr.help.clarivate.com/Content/glossary-average-jif-percentile.htm) | [optional] 9 | **half_life** | [**HalfLife**](HalfLife.md) | | [optional] 10 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/CategoryRecord.md: -------------------------------------------------------------------------------- 1 | # CategoryRecord 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | Category unique identifier | 8 | **name** | **str** | Category name | [optional] 9 | **edition** | **str** | Category edition | [optional] 10 | **category_code** | **str** | Two-letter category code | [optional] 11 | **description** | **str** | Detailed information about a category | [optional] 12 | **category_citation_reports** | [**CategoryCitationReports**](CategoryCitationReports.md) | | [optional] 13 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/JournalReportsMetrics.md: -------------------------------------------------------------------------------- 1 | # JournalReportsMetrics 2 | 3 | Key metrics information, including Impact Metrics (such as Journal Impact Factor), Influence Metrics (such as Eigen Factor), and Source Metrics (such as Citation Half-Life) 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **impact_metrics** | [**ImpactMetrics**](ImpactMetrics.md) | | [optional] 9 | **influence_metrics** | [**InfluenceMetrics**](InfluenceMetrics.md) | | [optional] 10 | **source_metrics** | [**SourceMetrics**](SourceMetrics.md) | | [optional] 11 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CategoryReportsSourceData.md: -------------------------------------------------------------------------------- 1 | # CategoryReportsSourceData 2 | 3 | Aggregate Source Data counting the number of citable items and the number of cited references in each type of item. 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **articles** | [**CategoryReportsSourceDataArticles**](CategoryReportsSourceDataArticles.md) | | [optional] 9 | **reviews** | [**CategoryReportsSourceDataReviews**](CategoryReportsSourceDataReviews.md) | | [optional] 10 | **other** | [**SourceDataArticles**](SourceDataArticles.md) | | [optional] 11 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/SourceData.md: -------------------------------------------------------------------------------- 1 | # SourceData 2 | 3 | Information about number of citable items in the JCR year. For the detailed description how this data is calculated please visit [this page](http://jcr.help.clarivate.com/Content/source-data.htm?Highlight=Source%20Data) 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **articles** | [**SourceDataArticles**](SourceDataArticles.md) | | [optional] 9 | **reviews** | [**SourceDataArticles**](SourceDataArticles.md) | | [optional] 10 | **other** | [**SourceDataArticles**](SourceDataArticles.md) | | [optional] 11 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CategoryListRecord.md: -------------------------------------------------------------------------------- 1 | # CategoryListRecord 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | Category unique identifier | [optional] 8 | **self** | **str** | Link to the category entity | [optional] 9 | **matches** | [**[SearchMatch]**](SearchMatch.md) | Search string matches across category names | [optional] 10 | **name** | **str** | Category name | [optional] 11 | **edition** | **str** | Category edition (SCIE/SSCI) | [optional] 12 | **category_citation_reports** | [**CategoryCitationReports**](CategoryCitationReports.md) | | [optional] 13 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/JournalHistoryRecord.md: -------------------------------------------------------------------------------- 1 | # JournalHistoryRecord 2 | 3 | Journal History record 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **name** | [**[JournalHistoryRecordName]**](JournalHistoryRecordName.md) | History of assigned names | [optional] 9 | **issn** | [**[JournalHistoryRecordIssn]**](JournalHistoryRecordIssn.md) | Previously assigned ISSN identifiers | [optional] 10 | **publisher** | [**[JournalHistoryRecordPublisher1]**](JournalHistoryRecordPublisher1.md) | Previously assigned publishers | [optional] 11 | **iso_title** | [**[JournalHistoryRecordIsoTitle]**](JournalHistoryRecordIsoTitle.md) | Previously assigned ISO titles | [optional] 12 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/Frequency.md: -------------------------------------------------------------------------------- 1 | # Frequency 2 | 3 | Number of journals in the category according to the number of times per year published 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **annual** | **int** | | [optional] 9 | **hemiannual** | **int** | | [optional] 10 | **triannual** | **int** | | [optional] 11 | **semiannual** | **int** | | [optional] 12 | **quarterly** | **int** | | [optional] 13 | **bimonthly** | **int** | | [optional] 14 | **monthly** | **int** | | [optional] 15 | **biweekly** | **int** | | [optional] 16 | **weekly** | **int** | | [optional] 17 | **daily** | **int** | | [optional] 18 | **irregular** | **int** | | [optional] 19 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 20 | 21 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 22 | 23 | 24 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | env/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | 27 | # PyInstaller 28 | # Usually these files are written by a python script from a template 29 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 30 | *.manifest 31 | *.spec 32 | 33 | # Installer logs 34 | pip-log.txt 35 | pip-delete-this-directory.txt 36 | 37 | # Unit test / coverage reports 38 | htmlcov/ 39 | .tox/ 40 | .coverage 41 | .coverage.* 42 | .cache 43 | nosetests.xml 44 | coverage.xml 45 | *,cover 46 | .hypothesis/ 47 | venv/ 48 | .venv/ 49 | .python-version 50 | .pytest_cache 51 | 52 | # Translations 53 | *.mo 54 | *.pot 55 | 56 | # Django stuff: 57 | *.log 58 | 59 | # Sphinx documentation 60 | docs/_build/ 61 | 62 | # PyBuilder 63 | target/ 64 | 65 | #Ipython Notebook 66 | .ipynb_checkpoints 67 | -------------------------------------------------------------------------------- /.openapi-generator-ignore: -------------------------------------------------------------------------------- 1 | # OpenAPI Generator Ignore 2 | # Generated by openapi-generator https://github.com/openapitools/openapi-generator 3 | 4 | # Use this file to prevent files from being overwritten by the generator. 5 | # The patterns follow closely to .gitignore or .dockerignore. 6 | 7 | # As an example, the C# client generator defines ApiClient.cs. 8 | # You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: 9 | #ApiClient.cs 10 | 11 | # You can match any string of characters against a directory, file or extension with a single asterisk (*): 12 | #foo/*/qux 13 | # The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux 14 | 15 | # You can recursively match patterns against a directory, file or extension with a double asterisk (**): 16 | #foo/**/qux 17 | # This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux 18 | 19 | # You can also negate patterns with an exclamation (!). 20 | # For example, you can ignore all files in a docs folder with the file extension .md: 21 | #docs/*.md 22 | # Then explicitly reverse the ignore rule for a single file: 23 | #!docs/README.md 24 | -------------------------------------------------------------------------------- /docs/CategoryReports.md: -------------------------------------------------------------------------------- 1 | # CategoryReports 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **year** | **int** | | 8 | **journals** | [**CategoryReportsJournals**](CategoryReportsJournals.md) | | [optional] 9 | **articles** | **int** | | [optional] 10 | **cites** | **int** | | [optional] 11 | **jif** | [**Jif**](Jif.md) | | [optional] 12 | **immediacy** | [**Immediacy**](Immediacy.md) | | [optional] 13 | **half_life** | [**HalfLife**](HalfLife.md) | | [optional] 14 | **frequency** | [**Frequency**](Frequency.md) | | [optional] 15 | **source_data** | [**CategoryReportsSourceData**](CategoryReportsSourceData.md) | | [optional] 16 | **category_data** | [**CategoryData**](CategoryData.md) | | [optional] 17 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 18 | 19 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/Ranks.md: -------------------------------------------------------------------------------- 1 | # Ranks 2 | 3 | JCR rank and ESI Total cites. Detailed information could be found on [this page](http://jcr.help.clarivate.com/Content/journal-profile-rank.htm) 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **jif** | [**[RanksJif]**](RanksJif.md) | | [optional] 9 | **article_influence** | [**[RankQuartileData]**](RankQuartileData.md) | | [optional] 10 | **eigen_factor_score** | [**[RankQuartileData]**](RankQuartileData.md) | | [optional] 11 | **immediacy_index** | [**[RankQuartileData]**](RankQuartileData.md) | | [optional] 12 | **jci** | [**[JournalListRecordRanksJci]**](JournalListRecordRanksJci.md) | | [optional] 13 | **esi_citations** | [**[RanksEsiCitations]**](RanksEsiCitations.md) | | [optional] 14 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 15 | 16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/InfluenceMetricsEigenFactor.md: -------------------------------------------------------------------------------- 1 | # InfluenceMetricsEigenFactor 2 | 3 | Eigenfactor score metrics (score and normalized score), available for journals reports dated 2007 or later. For more information, please visit the [JCR Glossary page](http://jcr.help.clarivate.com/Content/glossary.htm#610062182_anchor23) 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **score** | **float** | Eigenfactor score. For more information, please visit the [JCR Glossary page](http://jcr.help.clarivate.com/Content/glossary.htm#610062182_anchor24) | [optional] 9 | **normalized** | **float** | Normalized Eigenfactor score. For more information, please visit the [JCR Glossary page](http://jcr.help.clarivate.com/Content/glossary.htm#610062182_anchor33) | [optional] 10 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/JournalReports.md: -------------------------------------------------------------------------------- 1 | # JournalReports 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **year** | **int** | Report year | [optional] 8 | **suppressed** | **bool** | Suppressed Title. Read more at in [JCR Help](https://jcr.help.clarivate.com/Content/title-suppressions.htm) | [optional] 9 | **journal** | [**JournalReportsJournal**](JournalReportsJournal.md) | | [optional] 10 | **metrics** | [**JournalReportsMetrics**](JournalReportsMetrics.md) | | [optional] 11 | **ranks** | [**Ranks**](Ranks.md) | | [optional] 12 | **journal_data** | [**JournalData**](JournalData.md) | | [optional] 13 | **source_data** | [**SourceData**](SourceData.md) | | [optional] 14 | **journal_profile** | [**JournalProfile**](JournalProfile.md) | | [optional] 15 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 16 | 17 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/JournalListRecord.md: -------------------------------------------------------------------------------- 1 | # JournalListRecord 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | Journal unique identifier | [optional] 8 | **self** | **str** | Link to the journal entity | [optional] 9 | **matches** | [**[SearchMatch]**](SearchMatch.md) | | [optional] 10 | **name** | **str** | Journal full name | [optional] 11 | **categories** | [**Categories**](Categories.md) | | [optional] 12 | **journal_citation_reports** | [**[JournalListRecordJournalCitationReports]**](JournalListRecordJournalCitationReports.md) | Journal citation report link (only if the filter \"jcrYear\" was selected) | [optional] 13 | **metrics** | [**JournalListRecordMetrics**](JournalListRecordMetrics.md) | | [optional] 14 | **ranks** | [**JournalListRecordRanks**](JournalListRecordRanks.md) | | [optional] 15 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 16 | 17 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/JournalProfile.md: -------------------------------------------------------------------------------- 1 | # JournalProfile 2 | 3 | Journal Profile uses JCR year source data, and the two prior years to develop a picture of the countries, regions, and organizations that have published materials in this journal in the past three years. 4 | 5 | ## Properties 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **start_year** | **int** | First year of the profile | [optional] 9 | **end_year** | **int** | Last year of the profile (equal to the Report year) | [optional] 10 | **citable_items** | [**JournalProfileCitableItems**](JournalProfileCitableItems.md) | | [optional] 11 | **citations** | [**JournalProfileCitations**](JournalProfileCitations.md) | | [optional] 12 | **occurrence_countries** | [**[JournalProfileOccurrenceCountries]**](JournalProfileOccurrenceCountries.md) | Information about of the top 10 countries and regions that have published materials in this journal in the past three years. | [optional] 13 | **occurrence_organizations** | [**[JournalProfileOccurrenceOrganizations]**](JournalProfileOccurrenceOrganizations.md) | Information about of the top 10 organizations that have published materials in this journal in the past three years. | [optional] 14 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 15 | 16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/ImpactMetrics.md: -------------------------------------------------------------------------------- 1 | # ImpactMetrics 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **total_cites** | **int** | The total number of times that a journal has been cited by all journals included in the database in the JCR year. For more information, please visit the [JCR Glossary page](http://jcr.help.clarivate.com/Content/glossary.htm#610062182_anchor38) | [optional] 8 | **jif** | **str** | Journal Impact Factor. For more information, please visit the [JCR Glossary page](http://jcr.help.clarivate.com/Content/glossary.htm#610062182_anchor28) | [optional] 9 | **jif_without_self_citations** | **str** | Journal Impact Factor without self cites. | [optional] 10 | **jif5_years** | **float** | Average number of times articles from the journal published in the past five years have been cited in the JCR year | [optional] 11 | **immediacy_index** | **float** | Average number of times an article is cited in the year it is published. For more information, please visit the [JCR Glossary page](http://jcr.help.clarivate.com/Content/glossary.htm#610062182_anchor25) | [optional] 12 | **jci** | **float** | The Journal Citation Indicator is a new field-normalized metric that is calculated for all journals in the Web of Science Core Collection. The value represents the average category-normalized citation impact for papers published in the prior three-year period. | [optional] 13 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/JournalRecord.md: -------------------------------------------------------------------------------- 1 | # JournalRecord 2 | 3 | 4 | ## Properties 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **str** | Journal unique identifier | [optional] 8 | **name** | **str** | Journal title | [optional] 9 | **jcr_title** | **str** | Journal JCR abbreviation | [optional] 10 | **iso_title** | **str** | Journal title in [ISO format](https://www.issn.org/services/online-services/access-to-the-ltwa/) | [optional] 11 | **issn** | **str** | Current [ISSN identifier](https://www.issn.org/understanding-the-issn/what-is-an-issn/) | [optional] 12 | **previous_issn** | **[str]** | Previously assignled ISSN identifiers | [optional] 13 | **e_issn** | **str** | (For online journals) [Electronic ISSN](https://www.issn.org/understanding-the-issn/assignment-rules/the-issn-for-electronic-media/) identifier | [optional] 14 | **publisher** | [**Publisher**](Publisher.md) | | [optional] 15 | **frequency** | **int** | Number of times per year the journal is published | [optional] 16 | **first_issue_year** | **int** | First year the journal was published | [optional] 17 | **language** | **str** | Journal publication language | [optional] 18 | **open_access** | [**OpenAccess**](OpenAccess.md) | | [optional] 19 | **categories** | [**Categories**](Categories.md) | | [optional] 20 | **journal_citation_reports** | [**JournalCitationReport**](JournalCitationReport.md) | | [optional] 21 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] 22 | 23 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 24 | 25 | 26 | -------------------------------------------------------------------------------- /git_push.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ 3 | # 4 | # Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" 5 | 6 | git_user_id=$1 7 | git_repo_id=$2 8 | release_note=$3 9 | git_host=$4 10 | 11 | if [ "$git_host" = "" ]; then 12 | git_host="github.com" 13 | echo "[INFO] No command line input provided. Set \$git_host to $git_host" 14 | fi 15 | 16 | if [ "$git_user_id" = "" ]; then 17 | git_user_id="GIT_USER_ID" 18 | echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" 19 | fi 20 | 21 | if [ "$git_repo_id" = "" ]; then 22 | git_repo_id="GIT_REPO_ID" 23 | echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" 24 | fi 25 | 26 | if [ "$release_note" = "" ]; then 27 | release_note="Minor update" 28 | echo "[INFO] No command line input provided. Set \$release_note to $release_note" 29 | fi 30 | 31 | # Initialize the local directory as a Git repository 32 | git init 33 | 34 | # Adds the files in the local repository and stages them for commit. 35 | git add . 36 | 37 | # Commits the tracked changes and prepares them to be pushed to a remote repository. 38 | git commit -m "$release_note" 39 | 40 | # Sets the new remote 41 | git_remote=$(git remote) 42 | if [ "$git_remote" = "" ]; then # git remote not defined 43 | 44 | if [ "$GIT_TOKEN" = "" ]; then 45 | echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." 46 | git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git 47 | else 48 | git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git 49 | fi 50 | 51 | fi 52 | 53 | git pull origin master 54 | 55 | # Pushes (Forces) the changes in the local repository up to the remote repository 56 | echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" 57 | git push origin master 2>&1 | grep -v 'To https' 58 | -------------------------------------------------------------------------------- /example.py: -------------------------------------------------------------------------------- 1 | import time 2 | import clarivate.wos_journals.client 3 | from clarivate.wos_journals.client.api import journals_api 4 | from clarivate.wos_journals.client.model.journal_list import JournalList 5 | from pprint import pprint 6 | 7 | # See configuration.py for a list of all supported configuration parameters. 8 | 9 | configuration = clarivate.wos_journals.client.Configuration() 10 | configuration.api_key['key'] = 'YOUR API KEY' 11 | 12 | # Enter a context with an instance of the API client 13 | with clarivate.wos_journals.client.ApiClient(configuration) as api_client: 14 | # Create an instance of the API class 15 | api_instance = journals_api.JournalsApi(api_client) 16 | q = "cancer" # str | Free-text search by journal name (e.g. *Nature Genetics*), JCR abbreviation (e.g. *NAT GENET*), publisher (e.g. *PUBLIC LIBRARY SCIENCE*) or [ISSN / eISSN code](https://www.issn.org/understanding-the-issn/what-is-an-issn/) (e.g. *1061-4036*) The search logic is described in the section [Search](#search). (optional) 17 | edition = "SCIE" # str | Filter by Web of Science Citation Index. The following indexes (editions) are presented: - SCIE - Science Citation Index Expanded - SSCI - Social Sciences Citation Index - AHCI - Arts & Humanities Citation Index - ESCI - Emerging Sources Citation Index Multiple values are allowed, separated by a semicolon ( **;** ) (optional) 18 | category_code = None # str | Filter journals by category identifiers. Each journal in JCR is assigned to at least one of the subject categories, indicating a general area of science or the social sciences. Journals may be included in more than one subject category. Multiple values are allowed, separated by a semicolon ( **;** ) (optional) 19 | jcr_year = 2020 # int | Filter by Journal Citation Report year (from 1997). **NOTE:** The filter **jcrYear** is mandatory while using **jif**, **jifPercentile**, **jifQuartile**, and **jci** filters Only one value is allowed. (optional) 20 | jif = "gte:0.0" # str | Filter by [Journal Impact Factor](http://jcr.help.clarivate.com/Content/jcr3-glossary.htm) (JIF). **NOTE:** The filter **jcrYear** is mandatory while using **jif** filter Filter logic is described in the section [Filter by range](#range) (optional) 21 | jif_percentile = "gte:70 AND lte:90.0" # str | Filter by [Journal Impact Factor Percentile](http://jcr.help.clarivate.com/Content/glossary-journal-impact-factor-percentile.htm), ranging from 0 to 100 **NOTE:** The filter **jcrYear** is mandatory while using **jifPercentile** filter Filter logic is described in the section [Filter by range](#range) (optional) 22 | jif_quartile = "Q1" # str | Filter by JIF quartile rank for a category, from highest to lowest based on their JIF value:
Q1 is represented by the top 25% of journals in the category;
Q2 is occupied by journals in the 25 to 50% group;
Q3 is occupied by journals in the 50 to 75% group;
Q4 is occupied by journals in the 75 to 100% group. **NOTE:** The filter **jcrYear** is mandatory while using **jifQuartile** filter Multiple values are allowed, separated by a semicolon ( **;** ) (optional) 23 | jci = "gte:0" # str | Filter by [Journal Citation Indicator](http://jcr.help.clarivate.com/Content/jcr3-glossary.htm) (JCI). **NOTE:** The filter **jcrYear** is mandatory while using **jci** filter Filter logic is described in the section [Filter by range](#range) (optional) 24 | jci_quartile = "Q1" # str | Filter by JCI quartile rank for a category, from highest to lowest based on their JCI value: Q1 is represented by the top 25% of journals in the category; Q2 is occupied by journals in the 25 to 50% group; Q3 is occupied by journals in the 50 to 75% group; Q4 is occupied by journals in the 75 to 100% group. **NOTE:** The filter **jcrYear** is mandatory while using **jciQuartile** filter Multiple values are allowed, separated by a semicolon ( **;** ) (optional) 25 | jci_percentile = "gte:70.0 AND lte:90.0" # str | Filter by Journal Citation Indicator (JCI) percentile, ranging from 0 to 100 **NOTE:** The filter **jcrYear** is mandatory while using **jciPercentile** filter Filter logic is described in the section [Filter by range](#range) (optional) 26 | page = 1 # int | Specifying a page to retrieve (optional) if omitted the server will use the default value of 1 27 | limit = 10 # int | Number of returned results, ranging from 0 to 50 (optional) if omitted the server will use the default value of 10 28 | 29 | # example passing only required values which don't have defaults set 30 | # and optional values 31 | try: 32 | # Search and filter across JCR Journals 33 | 34 | api_response_all_journals = api_instance.journals_get() 35 | api_response_filtered = api_instance.journals_get(q=q, edition=edition, jcr_year=jcr_year, 36 | jif=jif, jif_percentile=jif_percentile, jif_quartile=jif_quartile, 37 | jci=jci, jci_quartile=jci_quartile, jci_percentile=jci_percentile, 38 | page=page, limit=limit) 39 | pprint(api_response_all_journals) 40 | pprint(api_response_filtered) 41 | except clarivate.wos_journals.client.ApiException as e: 42 | print("Exception when calling JournalsApi->journals_get: %s\n" % e) 43 | -------------------------------------------------------------------------------- /clarivate/wos_journals/client/models/__init__.py: -------------------------------------------------------------------------------- 1 | # flake8: noqa 2 | 3 | # import all models into this package 4 | # if you have many models here with many references from one model to another this may 5 | # raise a RecursionError 6 | # to avoid this, import only the models that you directly need like: 7 | # from from clarivate.wos_journals.client.model.pet import Pet 8 | # or import this package, but before doing it, use: 9 | # import sys 10 | # sys.setrecursionlimit(n) 11 | 12 | from clarivate.wos_journals.client.model.categories import Categories 13 | from clarivate.wos_journals.client.model.categories_cited import CategoriesCited 14 | from clarivate.wos_journals.client.model.categories_cited_hits import CategoriesCitedHits 15 | from clarivate.wos_journals.client.model.categories_cited_journal import CategoriesCitedJournal 16 | from clarivate.wos_journals.client.model.categories_citing import CategoriesCiting 17 | from clarivate.wos_journals.client.model.categories_citing_hits import CategoriesCitingHits 18 | from clarivate.wos_journals.client.model.categories_citing_journal import CategoriesCitingJournal 19 | from clarivate.wos_journals.client.model.category_citation_reports import CategoryCitationReports 20 | from clarivate.wos_journals.client.model.category_data import CategoryData 21 | from clarivate.wos_journals.client.model.category_list import CategoryList 22 | from clarivate.wos_journals.client.model.category_list_record import CategoryListRecord 23 | from clarivate.wos_journals.client.model.category_record import CategoryRecord 24 | from clarivate.wos_journals.client.model.category_reports import CategoryReports 25 | from clarivate.wos_journals.client.model.category_reports_journals import CategoryReportsJournals 26 | from clarivate.wos_journals.client.model.category_reports_source_data import CategoryReportsSourceData 27 | from clarivate.wos_journals.client.model.category_reports_source_data_articles import CategoryReportsSourceDataArticles 28 | from clarivate.wos_journals.client.model.category_reports_source_data_reviews import CategoryReportsSourceDataReviews 29 | from clarivate.wos_journals.client.model.cited_data import CitedData 30 | from clarivate.wos_journals.client.model.cites import Cites 31 | from clarivate.wos_journals.client.model.citing_data import CitingData 32 | from clarivate.wos_journals.client.model.frequency import Frequency 33 | from clarivate.wos_journals.client.model.half_life import HalfLife 34 | from clarivate.wos_journals.client.model.immediacy import Immediacy 35 | from clarivate.wos_journals.client.model.impact_metrics import ImpactMetrics 36 | from clarivate.wos_journals.client.model.influence_metrics import InfluenceMetrics 37 | from clarivate.wos_journals.client.model.influence_metrics_eigen_factor import InfluenceMetricsEigenFactor 38 | from clarivate.wos_journals.client.model.jif import Jif 39 | from clarivate.wos_journals.client.model.jif_aggregate import JifAggregate 40 | from clarivate.wos_journals.client.model.journal_citation_report import JournalCitationReport 41 | from clarivate.wos_journals.client.model.journal_data import JournalData 42 | from clarivate.wos_journals.client.model.journal_history_record import JournalHistoryRecord 43 | from clarivate.wos_journals.client.model.journal_history_record_iso_title import JournalHistoryRecordIsoTitle 44 | from clarivate.wos_journals.client.model.journal_history_record_issn import JournalHistoryRecordIssn 45 | from clarivate.wos_journals.client.model.journal_history_record_name import JournalHistoryRecordName 46 | from clarivate.wos_journals.client.model.journal_history_record_publisher import JournalHistoryRecordPublisher 47 | from clarivate.wos_journals.client.model.journal_history_record_publisher1 import JournalHistoryRecordPublisher1 48 | from clarivate.wos_journals.client.model.journal_history_record_year import JournalHistoryRecordYear 49 | from clarivate.wos_journals.client.model.journal_history_record_year1 import JournalHistoryRecordYear1 50 | from clarivate.wos_journals.client.model.journal_history_record_year2 import JournalHistoryRecordYear2 51 | from clarivate.wos_journals.client.model.journal_history_record_year3 import JournalHistoryRecordYear3 52 | from clarivate.wos_journals.client.model.journal_list import JournalList 53 | from clarivate.wos_journals.client.model.journal_list_record import JournalListRecord 54 | from clarivate.wos_journals.client.model.journal_list_record_journal_citation_reports import JournalListRecordJournalCitationReports 55 | from clarivate.wos_journals.client.model.journal_list_record_metrics import JournalListRecordMetrics 56 | from clarivate.wos_journals.client.model.journal_list_record_metrics_impact_metrics import JournalListRecordMetricsImpactMetrics 57 | from clarivate.wos_journals.client.model.journal_list_record_metrics_source_metrics import JournalListRecordMetricsSourceMetrics 58 | from clarivate.wos_journals.client.model.journal_list_record_ranks import JournalListRecordRanks 59 | from clarivate.wos_journals.client.model.journal_list_record_ranks_jci import JournalListRecordRanksJci 60 | from clarivate.wos_journals.client.model.journal_list_record_ranks_jif import JournalListRecordRanksJif 61 | from clarivate.wos_journals.client.model.journal_profile import JournalProfile 62 | from clarivate.wos_journals.client.model.journal_profile_citable_items import JournalProfileCitableItems 63 | from clarivate.wos_journals.client.model.journal_profile_citations import JournalProfileCitations 64 | from clarivate.wos_journals.client.model.journal_profile_occurrence_countries import JournalProfileOccurrenceCountries 65 | from clarivate.wos_journals.client.model.journal_profile_occurrence_organizations import JournalProfileOccurrenceOrganizations 66 | from clarivate.wos_journals.client.model.journal_record import JournalRecord 67 | from clarivate.wos_journals.client.model.journal_reports import JournalReports 68 | from clarivate.wos_journals.client.model.journal_reports_journal import JournalReportsJournal 69 | from clarivate.wos_journals.client.model.journal_reports_metrics import JournalReportsMetrics 70 | from clarivate.wos_journals.client.model.journals_cited import JournalsCited 71 | from clarivate.wos_journals.client.model.journals_cited_hits import JournalsCitedHits 72 | from clarivate.wos_journals.client.model.journals_cites_journal import JournalsCitesJournal 73 | from clarivate.wos_journals.client.model.journals_citing import JournalsCiting 74 | from clarivate.wos_journals.client.model.journals_citing_hits import JournalsCitingHits 75 | from clarivate.wos_journals.client.model.metadata import Metadata 76 | from clarivate.wos_journals.client.model.open_access import OpenAccess 77 | from clarivate.wos_journals.client.model.publisher import Publisher 78 | from clarivate.wos_journals.client.model.rank_quartile_data import RankQuartileData 79 | from clarivate.wos_journals.client.model.ranks import Ranks 80 | from clarivate.wos_journals.client.model.ranks_esi_citations import RanksEsiCitations 81 | from clarivate.wos_journals.client.model.ranks_jif import RanksJif 82 | from clarivate.wos_journals.client.model.search_match import SearchMatch 83 | from clarivate.wos_journals.client.model.source_data import SourceData 84 | from clarivate.wos_journals.client.model.source_data_articles import SourceDataArticles 85 | from clarivate.wos_journals.client.model.source_metrics import SourceMetrics 86 | from clarivate.wos_journals.client.model.source_metrics_citable_items import SourceMetricsCitableItems 87 | -------------------------------------------------------------------------------- /test/test_cites.py: -------------------------------------------------------------------------------- 1 | """ 2 | Web of Science™ Journals API 3 | 4 | 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. ## Resources 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](https://developer.clarivate.com/apis/wos-journal). The access requires registration on the Portal and approval from the Clarivate Sales/Product teams to entitle to the API. ## Credentials All requests require authentication with an API Key authentication flow. For more details, check the [Guide](https://developer.clarivate.com/help/api-access#key_access). ## Content You can learn more about content at [Journal Citation Reports™ Product page](https://clarivate.com/webofsciencegroup/solutions/journal-citation-reports/), or in the [documentation](http://jcr.help.clarivate.com/Content/home.htm). ## Search (query parameter `q=`) 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. ### Boolean operators | 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` | ### Special symbols 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. ## Filtering 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*, ### Filter by values 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 ### Filter by range 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: for `jif=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: for `jif=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: for `jif=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: for `jif=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: for `jif=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). ## Pagination 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**: ```json \"metadata\": { \"total\": 91, \"page\": 1, \"limit\": 10 } ``` ## Errors 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 | | 404 | Suppressed Title | Suppressed Journal from specific year. Read more at [https://jcr.help.clarivate.com/Content/title-suppressions.htm](https://jcr.help.clarivate.com/Content/title-suppressions.htm) | | 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: ```json \"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: ```json { \"error_description\": \"The access token is missing\", \"error\": \"invalid_request\" } ``` # noqa: E501 5 | 6 | The version of the OpenAPI document: 1.0.0 7 | Generated by: https://openapi-generator.tech 8 | """ 9 | 10 | 11 | import sys 12 | import unittest 13 | 14 | import clarivate.wos_journals.client 15 | from clarivate.wos_journals.client.model.cites import Cites 16 | 17 | 18 | class TestCites(unittest.TestCase): 19 | """Cites unit test stubs""" 20 | 21 | def setUp(self): 22 | pass 23 | 24 | def tearDown(self): 25 | pass 26 | 27 | def testCites(self): 28 | """Test Cites""" 29 | # FIXME: construct object with mandatory attributes with example values 30 | # model = Cites() # noqa: E501 31 | pass 32 | 33 | 34 | if __name__ == '__main__': 35 | unittest.main() 36 | -------------------------------------------------------------------------------- /test/test_metadata.py: -------------------------------------------------------------------------------- 1 | """ 2 | Web of Science™ Journals API 3 | 4 | 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. ## Resources 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](https://developer.clarivate.com/apis/wos-journal). The access requires registration on the Portal and approval from the Clarivate Sales/Product teams to entitle to the API. ## Credentials All requests require authentication with an API Key authentication flow. For more details, check the [Guide](https://developer.clarivate.com/help/api-access#key_access). ## Content You can learn more about content at [Journal Citation Reports™ Product page](https://clarivate.com/webofsciencegroup/solutions/journal-citation-reports/), or in the [documentation](http://jcr.help.clarivate.com/Content/home.htm). ## Search (query parameter `q=`) 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. ### Boolean operators | 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` | ### Special symbols 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. ## Filtering 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*, ### Filter by values 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 ### Filter by range 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: for `jif=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: for `jif=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: for `jif=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: for `jif=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: for `jif=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). ## Pagination 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**: ```json \"metadata\": { \"total\": 91, \"page\": 1, \"limit\": 10 } ``` ## Errors 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 | | 404 | Suppressed Title | Suppressed Journal from specific year. Read more at [https://jcr.help.clarivate.com/Content/title-suppressions.htm](https://jcr.help.clarivate.com/Content/title-suppressions.htm) | | 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: ```json \"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: ```json { \"error_description\": \"The access token is missing\", \"error\": \"invalid_request\" } ``` # noqa: E501 5 | 6 | The version of the OpenAPI document: 1.0.0 7 | Generated by: https://openapi-generator.tech 8 | """ 9 | 10 | 11 | import sys 12 | import unittest 13 | 14 | import clarivate.wos_journals.client 15 | from clarivate.wos_journals.client.model.metadata import Metadata 16 | 17 | 18 | class TestMetadata(unittest.TestCase): 19 | """Metadata unit test stubs""" 20 | 21 | def setUp(self): 22 | pass 23 | 24 | def tearDown(self): 25 | pass 26 | 27 | def testMetadata(self): 28 | """Test Metadata""" 29 | # FIXME: construct object with mandatory attributes with example values 30 | # model = Metadata() # noqa: E501 31 | pass 32 | 33 | 34 | if __name__ == '__main__': 35 | unittest.main() 36 | -------------------------------------------------------------------------------- /test/test_half_life.py: -------------------------------------------------------------------------------- 1 | """ 2 | Web of Science™ Journals API 3 | 4 | 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. ## Resources 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](https://developer.clarivate.com/apis/wos-journal). The access requires registration on the Portal and approval from the Clarivate Sales/Product teams to entitle to the API. ## Credentials All requests require authentication with an API Key authentication flow. For more details, check the [Guide](https://developer.clarivate.com/help/api-access#key_access). ## Content You can learn more about content at [Journal Citation Reports™ Product page](https://clarivate.com/webofsciencegroup/solutions/journal-citation-reports/), or in the [documentation](http://jcr.help.clarivate.com/Content/home.htm). ## Search (query parameter `q=`) 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. ### Boolean operators | 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` | ### Special symbols 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. ## Filtering 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*, ### Filter by values 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 ### Filter by range 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: for `jif=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: for `jif=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: for `jif=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: for `jif=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: for `jif=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). ## Pagination 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**: ```json \"metadata\": { \"total\": 91, \"page\": 1, \"limit\": 10 } ``` ## Errors 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 | | 404 | Suppressed Title | Suppressed Journal from specific year. Read more at [https://jcr.help.clarivate.com/Content/title-suppressions.htm](https://jcr.help.clarivate.com/Content/title-suppressions.htm) | | 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: ```json \"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: ```json { \"error_description\": \"The access token is missing\", \"error\": \"invalid_request\" } ``` # noqa: E501 5 | 6 | The version of the OpenAPI document: 1.0.0 7 | Generated by: https://openapi-generator.tech 8 | """ 9 | 10 | 11 | import sys 12 | import unittest 13 | 14 | import clarivate.wos_journals.client 15 | from clarivate.wos_journals.client.model.half_life import HalfLife 16 | 17 | 18 | class TestHalfLife(unittest.TestCase): 19 | """HalfLife unit test stubs""" 20 | 21 | def setUp(self): 22 | pass 23 | 24 | def tearDown(self): 25 | pass 26 | 27 | def testHalfLife(self): 28 | """Test HalfLife""" 29 | # FIXME: construct object with mandatory attributes with example values 30 | # model = HalfLife() # noqa: E501 31 | pass 32 | 33 | 34 | if __name__ == '__main__': 35 | unittest.main() 36 | -------------------------------------------------------------------------------- /test/test_ranks_jif.py: -------------------------------------------------------------------------------- 1 | """ 2 | Web of Science™ Journals API 3 | 4 | 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. ## Resources 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](https://developer.clarivate.com/apis/wos-journal). The access requires registration on the Portal and approval from the Clarivate Sales/Product teams to entitle to the API. ## Credentials All requests require authentication with an API Key authentication flow. For more details, check the [Guide](https://developer.clarivate.com/help/api-access#key_access). ## Content You can learn more about content at [Journal Citation Reports™ Product page](https://clarivate.com/webofsciencegroup/solutions/journal-citation-reports/), or in the [documentation](http://jcr.help.clarivate.com/Content/home.htm). ## Search (query parameter `q=`) 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. ### Boolean operators | 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` | ### Special symbols 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. ## Filtering 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*, ### Filter by values 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 ### Filter by range 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: for `jif=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: for `jif=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: for `jif=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: for `jif=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: for `jif=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). ## Pagination 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**: ```json \"metadata\": { \"total\": 91, \"page\": 1, \"limit\": 10 } ``` ## Errors 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 | | 404 | Suppressed Title | Suppressed Journal from specific year. Read more at [https://jcr.help.clarivate.com/Content/title-suppressions.htm](https://jcr.help.clarivate.com/Content/title-suppressions.htm) | | 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: ```json \"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: ```json { \"error_description\": \"The access token is missing\", \"error\": \"invalid_request\" } ``` # noqa: E501 5 | 6 | The version of the OpenAPI document: 1.0.0 7 | Generated by: https://openapi-generator.tech 8 | """ 9 | 10 | 11 | import sys 12 | import unittest 13 | 14 | import clarivate.wos_journals.client 15 | from clarivate.wos_journals.client.model.ranks_jif import RanksJif 16 | 17 | 18 | class TestRanksJif(unittest.TestCase): 19 | """RanksJif unit test stubs""" 20 | 21 | def setUp(self): 22 | pass 23 | 24 | def tearDown(self): 25 | pass 26 | 27 | def testRanksJif(self): 28 | """Test RanksJif""" 29 | # FIXME: construct object with mandatory attributes with example values 30 | # model = RanksJif() # noqa: E501 31 | pass 32 | 33 | 34 | if __name__ == '__main__': 35 | unittest.main() 36 | -------------------------------------------------------------------------------- /test/test_cited_data.py: -------------------------------------------------------------------------------- 1 | """ 2 | Web of Science™ Journals API 3 | 4 | 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. ## Resources 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](https://developer.clarivate.com/apis/wos-journal). The access requires registration on the Portal and approval from the Clarivate Sales/Product teams to entitle to the API. ## Credentials All requests require authentication with an API Key authentication flow. For more details, check the [Guide](https://developer.clarivate.com/help/api-access#key_access). ## Content You can learn more about content at [Journal Citation Reports™ Product page](https://clarivate.com/webofsciencegroup/solutions/journal-citation-reports/), or in the [documentation](http://jcr.help.clarivate.com/Content/home.htm). ## Search (query parameter `q=`) 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. ### Boolean operators | 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` | ### Special symbols 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. ## Filtering 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*, ### Filter by values 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 ### Filter by range 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: for `jif=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: for `jif=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: for `jif=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: for `jif=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: for `jif=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). ## Pagination 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**: ```json \"metadata\": { \"total\": 91, \"page\": 1, \"limit\": 10 } ``` ## Errors 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 | | 404 | Suppressed Title | Suppressed Journal from specific year. Read more at [https://jcr.help.clarivate.com/Content/title-suppressions.htm](https://jcr.help.clarivate.com/Content/title-suppressions.htm) | | 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: ```json \"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: ```json { \"error_description\": \"The access token is missing\", \"error\": \"invalid_request\" } ``` # noqa: E501 5 | 6 | The version of the OpenAPI document: 1.0.0 7 | Generated by: https://openapi-generator.tech 8 | """ 9 | 10 | 11 | import sys 12 | import unittest 13 | 14 | import clarivate.wos_journals.client 15 | from clarivate.wos_journals.client.model.cited_data import CitedData 16 | 17 | 18 | class TestCitedData(unittest.TestCase): 19 | """CitedData unit test stubs""" 20 | 21 | def setUp(self): 22 | pass 23 | 24 | def tearDown(self): 25 | pass 26 | 27 | def testCitedData(self): 28 | """Test CitedData""" 29 | # FIXME: construct object with mandatory attributes with example values 30 | # model = CitedData() # noqa: E501 31 | pass 32 | 33 | 34 | if __name__ == '__main__': 35 | unittest.main() 36 | -------------------------------------------------------------------------------- /test/test_frequency.py: -------------------------------------------------------------------------------- 1 | """ 2 | Web of Science™ Journals API 3 | 4 | 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. ## Resources 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](https://developer.clarivate.com/apis/wos-journal). The access requires registration on the Portal and approval from the Clarivate Sales/Product teams to entitle to the API. ## Credentials All requests require authentication with an API Key authentication flow. For more details, check the [Guide](https://developer.clarivate.com/help/api-access#key_access). ## Content You can learn more about content at [Journal Citation Reports™ Product page](https://clarivate.com/webofsciencegroup/solutions/journal-citation-reports/), or in the [documentation](http://jcr.help.clarivate.com/Content/home.htm). ## Search (query parameter `q=`) 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. ### Boolean operators | 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` | ### Special symbols 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. ## Filtering 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*, ### Filter by values 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 ### Filter by range 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: for `jif=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: for `jif=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: for `jif=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: for `jif=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: for `jif=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). ## Pagination 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**: ```json \"metadata\": { \"total\": 91, \"page\": 1, \"limit\": 10 } ``` ## Errors 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 | | 404 | Suppressed Title | Suppressed Journal from specific year. Read more at [https://jcr.help.clarivate.com/Content/title-suppressions.htm](https://jcr.help.clarivate.com/Content/title-suppressions.htm) | | 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: ```json \"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: ```json { \"error_description\": \"The access token is missing\", \"error\": \"invalid_request\" } ``` # noqa: E501 5 | 6 | The version of the OpenAPI document: 1.0.0 7 | Generated by: https://openapi-generator.tech 8 | """ 9 | 10 | 11 | import sys 12 | import unittest 13 | 14 | import clarivate.wos_journals.client 15 | from clarivate.wos_journals.client.model.frequency import Frequency 16 | 17 | 18 | class TestFrequency(unittest.TestCase): 19 | """Frequency unit test stubs""" 20 | 21 | def setUp(self): 22 | pass 23 | 24 | def tearDown(self): 25 | pass 26 | 27 | def testFrequency(self): 28 | """Test Frequency""" 29 | # FIXME: construct object with mandatory attributes with example values 30 | # model = Frequency() # noqa: E501 31 | pass 32 | 33 | 34 | if __name__ == '__main__': 35 | unittest.main() 36 | -------------------------------------------------------------------------------- /test/test_immediacy.py: -------------------------------------------------------------------------------- 1 | """ 2 | Web of Science™ Journals API 3 | 4 | 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. ## Resources 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](https://developer.clarivate.com/apis/wos-journal). The access requires registration on the Portal and approval from the Clarivate Sales/Product teams to entitle to the API. ## Credentials All requests require authentication with an API Key authentication flow. For more details, check the [Guide](https://developer.clarivate.com/help/api-access#key_access). ## Content You can learn more about content at [Journal Citation Reports™ Product page](https://clarivate.com/webofsciencegroup/solutions/journal-citation-reports/), or in the [documentation](http://jcr.help.clarivate.com/Content/home.htm). ## Search (query parameter `q=`) 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. ### Boolean operators | 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` | ### Special symbols 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. ## Filtering 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*, ### Filter by values 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 ### Filter by range 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: for `jif=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: for `jif=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: for `jif=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: for `jif=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: for `jif=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). ## Pagination 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**: ```json \"metadata\": { \"total\": 91, \"page\": 1, \"limit\": 10 } ``` ## Errors 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 | | 404 | Suppressed Title | Suppressed Journal from specific year. Read more at [https://jcr.help.clarivate.com/Content/title-suppressions.htm](https://jcr.help.clarivate.com/Content/title-suppressions.htm) | | 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: ```json \"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: ```json { \"error_description\": \"The access token is missing\", \"error\": \"invalid_request\" } ``` # noqa: E501 5 | 6 | The version of the OpenAPI document: 1.0.0 7 | Generated by: https://openapi-generator.tech 8 | """ 9 | 10 | 11 | import sys 12 | import unittest 13 | 14 | import clarivate.wos_journals.client 15 | from clarivate.wos_journals.client.model.immediacy import Immediacy 16 | 17 | 18 | class TestImmediacy(unittest.TestCase): 19 | """Immediacy unit test stubs""" 20 | 21 | def setUp(self): 22 | pass 23 | 24 | def tearDown(self): 25 | pass 26 | 27 | def testImmediacy(self): 28 | """Test Immediacy""" 29 | # FIXME: construct object with mandatory attributes with example values 30 | # model = Immediacy() # noqa: E501 31 | pass 32 | 33 | 34 | if __name__ == '__main__': 35 | unittest.main() 36 | -------------------------------------------------------------------------------- /test/test_publisher.py: -------------------------------------------------------------------------------- 1 | """ 2 | Web of Science™ Journals API 3 | 4 | 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. ## Resources 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](https://developer.clarivate.com/apis/wos-journal). The access requires registration on the Portal and approval from the Clarivate Sales/Product teams to entitle to the API. ## Credentials All requests require authentication with an API Key authentication flow. For more details, check the [Guide](https://developer.clarivate.com/help/api-access#key_access). ## Content You can learn more about content at [Journal Citation Reports™ Product page](https://clarivate.com/webofsciencegroup/solutions/journal-citation-reports/), or in the [documentation](http://jcr.help.clarivate.com/Content/home.htm). ## Search (query parameter `q=`) 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. ### Boolean operators | 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` | ### Special symbols 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. ## Filtering 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*, ### Filter by values 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 ### Filter by range 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: for `jif=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: for `jif=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: for `jif=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: for `jif=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: for `jif=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). ## Pagination 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**: ```json \"metadata\": { \"total\": 91, \"page\": 1, \"limit\": 10 } ``` ## Errors 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 | | 404 | Suppressed Title | Suppressed Journal from specific year. Read more at [https://jcr.help.clarivate.com/Content/title-suppressions.htm](https://jcr.help.clarivate.com/Content/title-suppressions.htm) | | 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: ```json \"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: ```json { \"error_description\": \"The access token is missing\", \"error\": \"invalid_request\" } ``` # noqa: E501 5 | 6 | The version of the OpenAPI document: 1.0.0 7 | Generated by: https://openapi-generator.tech 8 | """ 9 | 10 | 11 | import sys 12 | import unittest 13 | 14 | import clarivate.wos_journals.client 15 | from clarivate.wos_journals.client.model.publisher import Publisher 16 | 17 | 18 | class TestPublisher(unittest.TestCase): 19 | """Publisher unit test stubs""" 20 | 21 | def setUp(self): 22 | pass 23 | 24 | def tearDown(self): 25 | pass 26 | 27 | def testPublisher(self): 28 | """Test Publisher""" 29 | # FIXME: construct object with mandatory attributes with example values 30 | # model = Publisher() # noqa: E501 31 | pass 32 | 33 | 34 | if __name__ == '__main__': 35 | unittest.main() 36 | -------------------------------------------------------------------------------- /test/test_categories.py: -------------------------------------------------------------------------------- 1 | """ 2 | Web of Science™ Journals API 3 | 4 | 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. ## Resources 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](https://developer.clarivate.com/apis/wos-journal). The access requires registration on the Portal and approval from the Clarivate Sales/Product teams to entitle to the API. ## Credentials All requests require authentication with an API Key authentication flow. For more details, check the [Guide](https://developer.clarivate.com/help/api-access#key_access). ## Content You can learn more about content at [Journal Citation Reports™ Product page](https://clarivate.com/webofsciencegroup/solutions/journal-citation-reports/), or in the [documentation](http://jcr.help.clarivate.com/Content/home.htm). ## Search (query parameter `q=`) 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. ### Boolean operators | 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` | ### Special symbols 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. ## Filtering 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*, ### Filter by values 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 ### Filter by range 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: for `jif=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: for `jif=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: for `jif=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: for `jif=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: for `jif=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). ## Pagination 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**: ```json \"metadata\": { \"total\": 91, \"page\": 1, \"limit\": 10 } ``` ## Errors 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 | | 404 | Suppressed Title | Suppressed Journal from specific year. Read more at [https://jcr.help.clarivate.com/Content/title-suppressions.htm](https://jcr.help.clarivate.com/Content/title-suppressions.htm) | | 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: ```json \"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: ```json { \"error_description\": \"The access token is missing\", \"error\": \"invalid_request\" } ``` # noqa: E501 5 | 6 | The version of the OpenAPI document: 1.0.0 7 | Generated by: https://openapi-generator.tech 8 | """ 9 | 10 | 11 | import sys 12 | import unittest 13 | 14 | import clarivate.wos_journals.client 15 | from clarivate.wos_journals.client.model.categories import Categories 16 | 17 | 18 | class TestCategories(unittest.TestCase): 19 | """Categories unit test stubs""" 20 | 21 | def setUp(self): 22 | pass 23 | 24 | def tearDown(self): 25 | pass 26 | 27 | def testCategories(self): 28 | """Test Categories""" 29 | # FIXME: construct object with mandatory attributes with example values 30 | # model = Categories() # noqa: E501 31 | pass 32 | 33 | 34 | if __name__ == '__main__': 35 | unittest.main() 36 | -------------------------------------------------------------------------------- /test/test_citing_data.py: -------------------------------------------------------------------------------- 1 | """ 2 | Web of Science™ Journals API 3 | 4 | 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. ## Resources 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](https://developer.clarivate.com/apis/wos-journal). The access requires registration on the Portal and approval from the Clarivate Sales/Product teams to entitle to the API. ## Credentials All requests require authentication with an API Key authentication flow. For more details, check the [Guide](https://developer.clarivate.com/help/api-access#key_access). ## Content You can learn more about content at [Journal Citation Reports™ Product page](https://clarivate.com/webofsciencegroup/solutions/journal-citation-reports/), or in the [documentation](http://jcr.help.clarivate.com/Content/home.htm). ## Search (query parameter `q=`) 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. ### Boolean operators | 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` | ### Special symbols 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. ## Filtering 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*, ### Filter by values 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 ### Filter by range 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: for `jif=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: for `jif=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: for `jif=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: for `jif=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: for `jif=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). ## Pagination 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**: ```json \"metadata\": { \"total\": 91, \"page\": 1, \"limit\": 10 } ``` ## Errors 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 | | 404 | Suppressed Title | Suppressed Journal from specific year. Read more at [https://jcr.help.clarivate.com/Content/title-suppressions.htm](https://jcr.help.clarivate.com/Content/title-suppressions.htm) | | 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: ```json \"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: ```json { \"error_description\": \"The access token is missing\", \"error\": \"invalid_request\" } ``` # noqa: E501 5 | 6 | The version of the OpenAPI document: 1.0.0 7 | Generated by: https://openapi-generator.tech 8 | """ 9 | 10 | 11 | import sys 12 | import unittest 13 | 14 | import clarivate.wos_journals.client 15 | from clarivate.wos_journals.client.model.citing_data import CitingData 16 | 17 | 18 | class TestCitingData(unittest.TestCase): 19 | """CitingData unit test stubs""" 20 | 21 | def setUp(self): 22 | pass 23 | 24 | def tearDown(self): 25 | pass 26 | 27 | def testCitingData(self): 28 | """Test CitingData""" 29 | # FIXME: construct object with mandatory attributes with example values 30 | # model = CitingData() # noqa: E501 31 | pass 32 | 33 | 34 | if __name__ == '__main__': 35 | unittest.main() 36 | -------------------------------------------------------------------------------- /test/test_open_access.py: -------------------------------------------------------------------------------- 1 | """ 2 | Web of Science™ Journals API 3 | 4 | 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. ## Resources 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](https://developer.clarivate.com/apis/wos-journal). The access requires registration on the Portal and approval from the Clarivate Sales/Product teams to entitle to the API. ## Credentials All requests require authentication with an API Key authentication flow. For more details, check the [Guide](https://developer.clarivate.com/help/api-access#key_access). ## Content You can learn more about content at [Journal Citation Reports™ Product page](https://clarivate.com/webofsciencegroup/solutions/journal-citation-reports/), or in the [documentation](http://jcr.help.clarivate.com/Content/home.htm). ## Search (query parameter `q=`) 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. ### Boolean operators | 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` | ### Special symbols 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. ## Filtering 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*, ### Filter by values 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 ### Filter by range 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: for `jif=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: for `jif=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: for `jif=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: for `jif=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: for `jif=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). ## Pagination 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**: ```json \"metadata\": { \"total\": 91, \"page\": 1, \"limit\": 10 } ``` ## Errors 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 | | 404 | Suppressed Title | Suppressed Journal from specific year. Read more at [https://jcr.help.clarivate.com/Content/title-suppressions.htm](https://jcr.help.clarivate.com/Content/title-suppressions.htm) | | 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: ```json \"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: ```json { \"error_description\": \"The access token is missing\", \"error\": \"invalid_request\" } ``` # noqa: E501 5 | 6 | The version of the OpenAPI document: 1.0.0 7 | Generated by: https://openapi-generator.tech 8 | """ 9 | 10 | 11 | import sys 12 | import unittest 13 | 14 | import clarivate.wos_journals.client 15 | from clarivate.wos_journals.client.model.open_access import OpenAccess 16 | 17 | 18 | class TestOpenAccess(unittest.TestCase): 19 | """OpenAccess unit test stubs""" 20 | 21 | def setUp(self): 22 | pass 23 | 24 | def tearDown(self): 25 | pass 26 | 27 | def testOpenAccess(self): 28 | """Test OpenAccess""" 29 | # FIXME: construct object with mandatory attributes with example values 30 | # model = OpenAccess() # noqa: E501 31 | pass 32 | 33 | 34 | if __name__ == '__main__': 35 | unittest.main() 36 | -------------------------------------------------------------------------------- /test/test_search_match.py: -------------------------------------------------------------------------------- 1 | """ 2 | Web of Science™ Journals API 3 | 4 | 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. ## Resources 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](https://developer.clarivate.com/apis/wos-journal). The access requires registration on the Portal and approval from the Clarivate Sales/Product teams to entitle to the API. ## Credentials All requests require authentication with an API Key authentication flow. For more details, check the [Guide](https://developer.clarivate.com/help/api-access#key_access). ## Content You can learn more about content at [Journal Citation Reports™ Product page](https://clarivate.com/webofsciencegroup/solutions/journal-citation-reports/), or in the [documentation](http://jcr.help.clarivate.com/Content/home.htm). ## Search (query parameter `q=`) 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. ### Boolean operators | 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` | ### Special symbols 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. ## Filtering 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*, ### Filter by values 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 ### Filter by range 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: for `jif=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: for `jif=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: for `jif=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: for `jif=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: for `jif=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). ## Pagination 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**: ```json \"metadata\": { \"total\": 91, \"page\": 1, \"limit\": 10 } ``` ## Errors 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 | | 404 | Suppressed Title | Suppressed Journal from specific year. Read more at [https://jcr.help.clarivate.com/Content/title-suppressions.htm](https://jcr.help.clarivate.com/Content/title-suppressions.htm) | | 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: ```json \"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: ```json { \"error_description\": \"The access token is missing\", \"error\": \"invalid_request\" } ``` # noqa: E501 5 | 6 | The version of the OpenAPI document: 1.0.0 7 | Generated by: https://openapi-generator.tech 8 | """ 9 | 10 | 11 | import sys 12 | import unittest 13 | 14 | import clarivate.wos_journals.client 15 | from clarivate.wos_journals.client.model.search_match import SearchMatch 16 | 17 | 18 | class TestSearchMatch(unittest.TestCase): 19 | """SearchMatch unit test stubs""" 20 | 21 | def setUp(self): 22 | pass 23 | 24 | def tearDown(self): 25 | pass 26 | 27 | def testSearchMatch(self): 28 | """Test SearchMatch""" 29 | # FIXME: construct object with mandatory attributes with example values 30 | # model = SearchMatch() # noqa: E501 31 | pass 32 | 33 | 34 | if __name__ == '__main__': 35 | unittest.main() 36 | -------------------------------------------------------------------------------- /test/test_jif_aggregate.py: -------------------------------------------------------------------------------- 1 | """ 2 | Web of Science™ Journals API 3 | 4 | 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. ## Resources 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](https://developer.clarivate.com/apis/wos-journal). The access requires registration on the Portal and approval from the Clarivate Sales/Product teams to entitle to the API. ## Credentials All requests require authentication with an API Key authentication flow. For more details, check the [Guide](https://developer.clarivate.com/help/api-access#key_access). ## Content You can learn more about content at [Journal Citation Reports™ Product page](https://clarivate.com/webofsciencegroup/solutions/journal-citation-reports/), or in the [documentation](http://jcr.help.clarivate.com/Content/home.htm). ## Search (query parameter `q=`) 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. ### Boolean operators | 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` | ### Special symbols 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. ## Filtering 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*, ### Filter by values 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 ### Filter by range 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: for `jif=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: for `jif=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: for `jif=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: for `jif=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: for `jif=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). ## Pagination 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**: ```json \"metadata\": { \"total\": 91, \"page\": 1, \"limit\": 10 } ``` ## Errors 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 | | 404 | Suppressed Title | Suppressed Journal from specific year. Read more at [https://jcr.help.clarivate.com/Content/title-suppressions.htm](https://jcr.help.clarivate.com/Content/title-suppressions.htm) | | 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: ```json \"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: ```json { \"error_description\": \"The access token is missing\", \"error\": \"invalid_request\" } ``` # noqa: E501 5 | 6 | The version of the OpenAPI document: 1.0.0 7 | Generated by: https://openapi-generator.tech 8 | """ 9 | 10 | 11 | import sys 12 | import unittest 13 | 14 | import clarivate.wos_journals.client 15 | from clarivate.wos_journals.client.model.jif_aggregate import JifAggregate 16 | 17 | 18 | class TestJifAggregate(unittest.TestCase): 19 | """JifAggregate unit test stubs""" 20 | 21 | def setUp(self): 22 | pass 23 | 24 | def tearDown(self): 25 | pass 26 | 27 | def testJifAggregate(self): 28 | """Test JifAggregate""" 29 | # FIXME: construct object with mandatory attributes with example values 30 | # model = JifAggregate() # noqa: E501 31 | pass 32 | 33 | 34 | if __name__ == '__main__': 35 | unittest.main() 36 | -------------------------------------------------------------------------------- /test/test_impact_metrics.py: -------------------------------------------------------------------------------- 1 | """ 2 | Web of Science™ Journals API 3 | 4 | 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. ## Resources 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](https://developer.clarivate.com/apis/wos-journal). The access requires registration on the Portal and approval from the Clarivate Sales/Product teams to entitle to the API. ## Credentials All requests require authentication with an API Key authentication flow. For more details, check the [Guide](https://developer.clarivate.com/help/api-access#key_access). ## Content You can learn more about content at [Journal Citation Reports™ Product page](https://clarivate.com/webofsciencegroup/solutions/journal-citation-reports/), or in the [documentation](http://jcr.help.clarivate.com/Content/home.htm). ## Search (query parameter `q=`) 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. ### Boolean operators | 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` | ### Special symbols 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. ## Filtering 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*, ### Filter by values 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 ### Filter by range 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: for `jif=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: for `jif=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: for `jif=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: for `jif=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: for `jif=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). ## Pagination 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**: ```json \"metadata\": { \"total\": 91, \"page\": 1, \"limit\": 10 } ``` ## Errors 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 | | 404 | Suppressed Title | Suppressed Journal from specific year. Read more at [https://jcr.help.clarivate.com/Content/title-suppressions.htm](https://jcr.help.clarivate.com/Content/title-suppressions.htm) | | 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: ```json \"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: ```json { \"error_description\": \"The access token is missing\", \"error\": \"invalid_request\" } ``` # noqa: E501 5 | 6 | The version of the OpenAPI document: 1.0.0 7 | Generated by: https://openapi-generator.tech 8 | """ 9 | 10 | 11 | import sys 12 | import unittest 13 | 14 | import clarivate.wos_journals.client 15 | from clarivate.wos_journals.client.model.impact_metrics import ImpactMetrics 16 | 17 | 18 | class TestImpactMetrics(unittest.TestCase): 19 | """ImpactMetrics unit test stubs""" 20 | 21 | def setUp(self): 22 | pass 23 | 24 | def tearDown(self): 25 | pass 26 | 27 | def testImpactMetrics(self): 28 | """Test ImpactMetrics""" 29 | # FIXME: construct object with mandatory attributes with example values 30 | # model = ImpactMetrics() # noqa: E501 31 | pass 32 | 33 | 34 | if __name__ == '__main__': 35 | unittest.main() 36 | -------------------------------------------------------------------------------- /test/test_rank_quartile_data.py: -------------------------------------------------------------------------------- 1 | """ 2 | Web of Science™ Journals API 3 | 4 | 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. ## Resources 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](https://developer.clarivate.com/apis/wos-journal). The access requires registration on the Portal and approval from the Clarivate Sales/Product teams to entitle to the API. ## Credentials All requests require authentication with an API Key authentication flow. For more details, check the [Guide](https://developer.clarivate.com/help/api-access#key_access). ## Content You can learn more about content at [Journal Citation Reports™ Product page](https://clarivate.com/webofsciencegroup/solutions/journal-citation-reports/), or in the [documentation](http://jcr.help.clarivate.com/Content/home.htm). ## Search (query parameter `q=`) 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. ### Boolean operators | 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` | ### Special symbols 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. ## Filtering 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*, ### Filter by values 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 ### Filter by range 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: for `jif=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: for `jif=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: for `jif=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: for `jif=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: for `jif=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). ## Pagination 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**: ```json \"metadata\": { \"total\": 91, \"page\": 1, \"limit\": 10 } ``` ## Errors 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 | | 404 | Suppressed Title | Suppressed Journal from specific year. Read more at [https://jcr.help.clarivate.com/Content/title-suppressions.htm](https://jcr.help.clarivate.com/Content/title-suppressions.htm) | | 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: ```json \"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: ```json { \"error_description\": \"The access token is missing\", \"error\": \"invalid_request\" } ``` # noqa: E501 5 | 6 | The version of the OpenAPI document: 1.0.0 7 | Generated by: https://openapi-generator.tech 8 | """ 9 | 10 | 11 | import sys 12 | import unittest 13 | 14 | import clarivate.wos_journals.client 15 | from clarivate.wos_journals.client.model.rank_quartile_data import RankQuartileData 16 | 17 | 18 | class TestRankQuartileData(unittest.TestCase): 19 | """RankQuartileData unit test stubs""" 20 | 21 | def setUp(self): 22 | pass 23 | 24 | def tearDown(self): 25 | pass 26 | 27 | def testRankQuartileData(self): 28 | """Test RankQuartileData""" 29 | # FIXME: construct object with mandatory attributes with example values 30 | # model = RankQuartileData() # noqa: E501 31 | pass 32 | 33 | 34 | if __name__ == '__main__': 35 | unittest.main() 36 | -------------------------------------------------------------------------------- /test/test_ranks_esi_citations.py: -------------------------------------------------------------------------------- 1 | """ 2 | Web of Science™ Journals API 3 | 4 | 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. ## Resources 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](https://developer.clarivate.com/apis/wos-journal). The access requires registration on the Portal and approval from the Clarivate Sales/Product teams to entitle to the API. ## Credentials All requests require authentication with an API Key authentication flow. For more details, check the [Guide](https://developer.clarivate.com/help/api-access#key_access). ## Content You can learn more about content at [Journal Citation Reports™ Product page](https://clarivate.com/webofsciencegroup/solutions/journal-citation-reports/), or in the [documentation](http://jcr.help.clarivate.com/Content/home.htm). ## Search (query parameter `q=`) 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. ### Boolean operators | 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` | ### Special symbols 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. ## Filtering 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*, ### Filter by values 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 ### Filter by range 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: for `jif=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: for `jif=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: for `jif=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: for `jif=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: for `jif=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). ## Pagination 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**: ```json \"metadata\": { \"total\": 91, \"page\": 1, \"limit\": 10 } ``` ## Errors 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 | | 404 | Suppressed Title | Suppressed Journal from specific year. Read more at [https://jcr.help.clarivate.com/Content/title-suppressions.htm](https://jcr.help.clarivate.com/Content/title-suppressions.htm) | | 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: ```json \"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: ```json { \"error_description\": \"The access token is missing\", \"error\": \"invalid_request\" } ``` # noqa: E501 5 | 6 | The version of the OpenAPI document: 1.0.0 7 | Generated by: https://openapi-generator.tech 8 | """ 9 | 10 | 11 | import sys 12 | import unittest 13 | 14 | import clarivate.wos_journals.client 15 | from clarivate.wos_journals.client.model.ranks_esi_citations import RanksEsiCitations 16 | 17 | 18 | class TestRanksEsiCitations(unittest.TestCase): 19 | """RanksEsiCitations unit test stubs""" 20 | 21 | def setUp(self): 22 | pass 23 | 24 | def tearDown(self): 25 | pass 26 | 27 | def testRanksEsiCitations(self): 28 | """Test RanksEsiCitations""" 29 | # FIXME: construct object with mandatory attributes with example values 30 | # model = RanksEsiCitations() # noqa: E501 31 | pass 32 | 33 | 34 | if __name__ == '__main__': 35 | unittest.main() 36 | -------------------------------------------------------------------------------- /test/test_jif.py: -------------------------------------------------------------------------------- 1 | """ 2 | Web of Science™ Journals API 3 | 4 | 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. ## Resources 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](https://developer.clarivate.com/apis/wos-journal). The access requires registration on the Portal and approval from the Clarivate Sales/Product teams to entitle to the API. ## Credentials All requests require authentication with an API Key authentication flow. For more details, check the [Guide](https://developer.clarivate.com/help/api-access#key_access). ## Content You can learn more about content at [Journal Citation Reports™ Product page](https://clarivate.com/webofsciencegroup/solutions/journal-citation-reports/), or in the [documentation](http://jcr.help.clarivate.com/Content/home.htm). ## Search (query parameter `q=`) 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. ### Boolean operators | 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` | ### Special symbols 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. ## Filtering 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*, ### Filter by values 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 ### Filter by range 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: for `jif=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: for `jif=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: for `jif=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: for `jif=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: for `jif=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). ## Pagination 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**: ```json \"metadata\": { \"total\": 91, \"page\": 1, \"limit\": 10 } ``` ## Errors 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 | | 404 | Suppressed Title | Suppressed Journal from specific year. Read more at [https://jcr.help.clarivate.com/Content/title-suppressions.htm](https://jcr.help.clarivate.com/Content/title-suppressions.htm) | | 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: ```json \"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: ```json { \"error_description\": \"The access token is missing\", \"error\": \"invalid_request\" } ``` # noqa: E501 5 | 6 | The version of the OpenAPI document: 1.0.0 7 | Generated by: https://openapi-generator.tech 8 | """ 9 | 10 | 11 | import sys 12 | import unittest 13 | 14 | import clarivate.wos_journals.client 15 | from clarivate.wos_journals.client.model.jif_aggregate import JifAggregate 16 | globals()['JifAggregate'] = JifAggregate 17 | from clarivate.wos_journals.client.model.jif import Jif 18 | 19 | 20 | class TestJif(unittest.TestCase): 21 | """Jif unit test stubs""" 22 | 23 | def setUp(self): 24 | pass 25 | 26 | def tearDown(self): 27 | pass 28 | 29 | def testJif(self): 30 | """Test Jif""" 31 | # FIXME: construct object with mandatory attributes with example values 32 | # model = Jif() # noqa: E501 33 | pass 34 | 35 | 36 | if __name__ == '__main__': 37 | unittest.main() 38 | -------------------------------------------------------------------------------- /test/test_source_data_articles.py: -------------------------------------------------------------------------------- 1 | """ 2 | Web of Science™ Journals API 3 | 4 | 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. ## Resources 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](https://developer.clarivate.com/apis/wos-journal). The access requires registration on the Portal and approval from the Clarivate Sales/Product teams to entitle to the API. ## Credentials All requests require authentication with an API Key authentication flow. For more details, check the [Guide](https://developer.clarivate.com/help/api-access#key_access). ## Content You can learn more about content at [Journal Citation Reports™ Product page](https://clarivate.com/webofsciencegroup/solutions/journal-citation-reports/), or in the [documentation](http://jcr.help.clarivate.com/Content/home.htm). ## Search (query parameter `q=`) 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. ### Boolean operators | 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` | ### Special symbols 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. ## Filtering 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*, ### Filter by values 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 ### Filter by range 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: for `jif=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: for `jif=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: for `jif=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: for `jif=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: for `jif=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). ## Pagination 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**: ```json \"metadata\": { \"total\": 91, \"page\": 1, \"limit\": 10 } ``` ## Errors 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 | | 404 | Suppressed Title | Suppressed Journal from specific year. Read more at [https://jcr.help.clarivate.com/Content/title-suppressions.htm](https://jcr.help.clarivate.com/Content/title-suppressions.htm) | | 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: ```json \"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: ```json { \"error_description\": \"The access token is missing\", \"error\": \"invalid_request\" } ``` # noqa: E501 5 | 6 | The version of the OpenAPI document: 1.0.0 7 | Generated by: https://openapi-generator.tech 8 | """ 9 | 10 | 11 | import sys 12 | import unittest 13 | 14 | import clarivate.wos_journals.client 15 | from clarivate.wos_journals.client.model.source_data_articles import SourceDataArticles 16 | 17 | 18 | class TestSourceDataArticles(unittest.TestCase): 19 | """SourceDataArticles unit test stubs""" 20 | 21 | def setUp(self): 22 | pass 23 | 24 | def tearDown(self): 25 | pass 26 | 27 | def testSourceDataArticles(self): 28 | """Test SourceDataArticles""" 29 | # FIXME: construct object with mandatory attributes with example values 30 | # model = SourceDataArticles() # noqa: E501 31 | pass 32 | 33 | 34 | if __name__ == '__main__': 35 | unittest.main() 36 | -------------------------------------------------------------------------------- /clarivate/wos_journals/client/__init__.py: -------------------------------------------------------------------------------- 1 | # flake8: noqa 2 | 3 | """ 4 | Web of Science™ Journals API 5 | 6 | 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. ## Resources 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](https://developer.clarivate.com/apis/wos-journal). The access requires registration on the Portal and approval from the Clarivate Sales/Product teams to entitle to the API. ## Credentials All requests require authentication with an API Key authentication flow. For more details, check the [Guide](https://developer.clarivate.com/help/api-access#key_access). ## Content You can learn more about content at [Journal Citation Reports™ Product page](https://clarivate.com/webofsciencegroup/solutions/journal-citation-reports/), or in the [documentation](http://jcr.help.clarivate.com/Content/home.htm). ## Search (query parameter `q=`) 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. ### Boolean operators | 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` | ### Special symbols 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. ## Filtering 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*, ### Filter by values 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 ### Filter by range 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: for `jif=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: for `jif=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: for `jif=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: for `jif=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: for `jif=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). ## Pagination 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**: ```json \"metadata\": { \"total\": 91, \"page\": 1, \"limit\": 10 } ``` ## Errors 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 | | 404 | Suppressed Title | Suppressed Journal from specific year. Read more at [https://jcr.help.clarivate.com/Content/title-suppressions.htm](https://jcr.help.clarivate.com/Content/title-suppressions.htm) | | 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: ```json \"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: ```json { \"error_description\": \"The access token is missing\", \"error\": \"invalid_request\" } ``` # noqa: E501 7 | 8 | The version of the OpenAPI document: 1.0.0 9 | Generated by: https://openapi-generator.tech 10 | """ 11 | 12 | 13 | __version__ = "1.0.0" 14 | 15 | # import ApiClient 16 | from clarivate.wos_journals.client.api_client import ApiClient 17 | 18 | # import Configuration 19 | from clarivate.wos_journals.client.configuration import Configuration 20 | 21 | # import exceptions 22 | from clarivate.wos_journals.client.exceptions import OpenApiException 23 | from clarivate.wos_journals.client.exceptions import ApiAttributeError 24 | from clarivate.wos_journals.client.exceptions import ApiTypeError 25 | from clarivate.wos_journals.client.exceptions import ApiValueError 26 | from clarivate.wos_journals.client.exceptions import ApiKeyError 27 | from clarivate.wos_journals.client.exceptions import ApiException 28 | --------------------------------------------------------------------------------