A search on a preferred organization name returns all records that contain the preferred name and all records that contain its name variants. A search on a name variant returns all records that contain the variant. For example, Cornell Law Sch returns all records that contain Cornell Law Sch in the Addresses field.
When searching for organization names that contain a Boolean (AND, NOT, NEAR, and SAME), always enclose the word in quotation marks ( \" \" ). For example:
- OG=(Japan Science \"and\" Technology Agency (JST))
- OG=(\"Near\" East Univ)
- OG=(\"OR\" Hlth Sci Univ) |\n| TS | Searches for topic terms in the following fields within a document:
- Title
- Abstract
- Author keywords
- Keywords Plus\n| SUR | Searches records in DRCI by repository \"SourceURL\". Search values must be inside double quotes\n\n## Pagination\nTo ensure fast response time, each search or multiple entity calls (such as `/documents`) retrieve only a certain number of hits/records.\n\nThere are two optional request parameters to browse along with the result: _limit_ and _page_.\n\n- limit: Number of returned results, ranging from 0 to 50 (default **10**)\n- page: Specifying a page to retrieve (default **1**)\n\nMoreover, this information is shown in the response body, in the tag **metadata**:\n\n```json\n\"metadata\": {\n \"total\": 91,\n \"page\": 1,\n \"limit\": 10\n}\n```\n\n## Errors\nThe Web of Science Starter 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.\n\n| Code | Title | Description |\n|---|---|---|\n| 400 | Bad request | Request syntax error |\n| 401 | Unauthorized | The API key is invalid or missed |\n| 404 | Not found | The resource is not found |\n| 405 | Method not allowed | Method other than GET is not allowed |\n| 50X | Server errors | Technical error with servers|\nEach 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:\n\n```json\n \"error\": {\n \"status\": 404,\n \"title\": \"Resource couldn't be found\",\n \"details\": \"There is no record found in the Web of Science database. Please check your query.\"\n }\n```\nFor the `401 Unauthorized` error the response body is a little bit different:\n```json\n{\n \"error_description\": \"The access token is missing\",\n \"error\": \"invalid_request\"\n}\n","license":{"name":"Clarivate Content as a Service Licence","url":"https://clarivate.com/download/web-of-science-incites-apis/"}},"tags":[{"name":"Documents","description":"Web of Science Documents"},{"name":"Journals","description":"Web of Science Journals"}],"paths":{"/journals":{"get":{"tags":["Journals"],"summary":"Query Journals by ISSN","parameters":[{"name":"issn","in":"query","description":"Query Journal by ISSN","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JournalsList"},"example":{"metadata":{"total":1,"page":1,"limit":10},"hits":[{"id":"ANAT_REC_PART_A","name":"ANATOMICAL RECORD PART A-DISCOVERIES IN MOLECULAR CELLULAR AND EVOLUTIONARY BIOLOGY","jcrTitle":"ANAT REC PART A","isoTitle":"Anat. Rec. Part A","issn":"1552-4884","previousIssn":["0003-276X"],"eIssn":"1552-4892","links":[{"type":"Journal Citation Report record","url":"https://www.webofscience.com/api/gateway?GWVersion=2&SrcApp=&SrcAuth=WoSMatcher&KeyISSN=1552-4884&DestApp=JCR"}]}]}}}}}}},"/journals/{id}":{"get":{"tags":["Journals"],"summary":"Get Journal by ID","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"example":"ANAT_REC_PART_A"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Journal"},"example":{"id":"ENDOCRINE","name":"ENDOCRINE","jcrTitle":"ENDOCRINE","isoTitle":"Endocrine","issn":"1355-008X","previousIssn":["0969-711X"],"eIssn":"1559-0100","links":[{"type":"Journal Citation Report record","url":"https://www.webofscience.com/api/gateway?GWVersion=2&SrcApp=devportal_app_name&SrcAuth=WoSMatcher&KeyISSN=1355-008X&DestApp=JCR"}]}}}}}}},"/documents":{"get":{"tags":["Documents"],"summary":"Query Web of Science documents\n","description":"The endpoint allows to search, filter, or browse across the Web of Science document content by using [advanced search query builder](https://webofscience.help.clarivate.com/en-us/Content/advanced-search.html).\n","parameters":[{"name":"db","in":"query","required":false,"description":"Web of Science Database abbreviation\n* WOS - Web of Science Core collection\n* BIOABS - Biological Abstracts\n* BCI - BIOSIS Citation Index\n* BIOSIS - BIOSIS Previews\n* CCC - Current Contents Connect\n* DIIDW - Derwent Innovations Index\n* DRCI - Data Citation Index\n* MEDLINE - MEDLINE The U.S. National Library of Medicine® (NLM®) premier life sciences database.\n* ZOOREC - Zoological Records\n* PPRN - Preprint Citation Index\n* RC - Research Commons\n* WOK - All databases\n","schema":{"type":"string","enum":["BCI","BIOABS","BIOSIS","CCC","DIIDW","DRCI","MEDLINE","PPRN","RC","WOK","WOS","ZOOREC"],"default":"WOS"}},{"name":"q","in":"query","description":"Web of Science advanced [advanced search query builder](https://webofscience.help.clarivate.com/en-us/Content/advanced-search.html). The supported field tags are listed in description.","required":true,"schema":{"type":"string","example":"PY=2020"}},{"name":"limit","description":"set the limit of records on the page (1-50)","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":10,"minimum":1,"maximum":50}},{"name":"page","description":"set the result page","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"sortField","in":"query","required":false,"schema":{"type":"string"},"examples":{"LoadDate":{"value":"LD+D","summary":"Load Date (Descending)"},"LoadDate Asc":{"value":"LD+A","summary":"Load Date (Ascending)"},"Author":{"value":"PY+D","summary":"Publication Year (Descending)"},"Author Asc":{"value":"PY+A","summary":"Publication Year (Ascending)"},"Rel D":{"value":"RS+D","summary":"Relevance (Descending)"},"Rel A":{"value":"RS+A","summary":"Relevance (Ascending)"},"TC D":{"value":"TC+D","summary":"Times Cited (Descending)"},"TC A":{"value":"TC+A","summary":"Times Cited (Ascending)"}},"description":"Order by field(s). Field name and order by clause separated by '+', use A for ASC and D for DESC, ex: PY+D. Multiple values are separated by comma. Supported fields:\n\n* **LD** - Load Date\n* **PY** - Publication Year\n* **RS** - Relevance\n* **TC** - Times Cited\n"},{"name":"modifiedTimeSpan","in":"query","required":false,"schema":{"type":"string"},"description":"Defines a date range in which the results were most recently modified. Beginning and end dates must be specified in the yyyy-mm-dd format separated by '+' or ' ', e.g. 2023-01-01+2023-12-31. This parameter is not compatible with the all databases search, i.e. db=WOK is not compatible with this parameter."},{"name":"publishTimeSpan","in":"query","required":false,"schema":{"type":"string"},"description":"Defines a date range in which the results were published. Beginning and end dates must be specified in the yyyy-mm-dd format separated by '+' or ' ', e.g. 2023-01-01+2023-12-31. This parameter cannot be combined with modifiedTimeSpan"},{"name":"tcModifiedTimeSpan","in":"query","required":false,"schema":{"type":"string"},"description":"Defines a date range in which times cited counts were modified. Beginning and end dates must be specified in the yyyy-mm-dd format separated by '+' or ' ', e.g. 2023-01-01+2023-12-31. This parameter is not compatible with the all databases search, i.e. db=WOK is not compatible with this parameter."},{"name":"detail","in":"query","required":false,"schema":{"type":"string"},"description":"it will returns the full data by default, if detail=short it returns the limited data"},{"name":"edition","in":"query","description":"Edition(s) to be searched. If null, user permissions will be substituted. Must include the name of the collection and edition name separated by '+' or ' ', ex: WOS+SCI. Multiple editions are separated by ','. Editions available for collection (WOS) - AHCI,CCR,IC,ISSHP,ISTP,SCI,SSCI,BHCI,BSCI and ESCI.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentsList"},"example":{"metadata":{"total":2,"page":1,"limit":10},"hits":[{"uid":"WOS:A1993MM96800012","title":"'EPITAFIO'","types":["Poetry"],"sourceTypes":["Poetry"],"source":{"sourceTitle":"CUADERNOS HISPANOAMERICANOS","publishYear":1993,"publishMonth":"NOV","issue":"521","pages":{"range":"125-125","begin":"125","end":"125","count":1}},"names":{"authors":[{"displayName":"TOMLINSON, C","wosStandard":"TOMLINSON, C","researcherId":"GGU-9939-2022"}]},"links":{"record":"https://www.webofscience.com/api/gateway?GWVersion=2&SrcApp=&SrcAuth=WosAPI&KeyUT=WOS:A1993MM96800012&DestLinkType=FullRecord&DestApp=WOS"},"citations":[{"db":"WOS","count":0}],"identifiers":{"issn":"1131-6438"},"keywords":{"authorKeywords":[]}},{"uid":"WOS:000222526200005","title":"Mapping the land of 'I-don't remember': For a re-evaluation of La 'Historia oficial'","types":["Article"],"sourceTypes":["Article"],"source":{"sourceTitle":"BULLETIN OF HISPANIC STUDIES","publishYear":2004,"publishMonth":"APR","volume":"81","issue":"2","pages":{"range":"215-228","begin":"215","end":"228","count":14}},"names":{"authors":[{"displayName":"Tomlinson, E","wosStandard":"Tomlinson, E","researcherId":"AAG-1344-2019"}],"bookEditors":[{"displayName":"Walker, J. M."}]},"links":{"record":"https://www.webofscience.com/api/gateway?GWVersion=2&SrcApp=&SrcAuth=WosAPI&KeyUT=WOS:000222526200005&DestLinkType=FullRecord&DestApp=WOS","citingArticles":"https://www.webofscience.com/api/gateway?GWVersion=2&SrcApp=&SrcAuth=WosAPI&KeyUT=WOS:000222526200005&DestLinkType=CitingArticles&DestApp=WOS","references":"https://www.webofscience.com/api/gateway?GWVersion=2&SrcApp=&SrcAuth=WosAPI&KeyUT=WOS:000222526200005&DestLinkType=CitedReferences&DestApp=WOS","related":"https://www.webofscience.com/api/gateway?GWVersion=2&SrcApp=&SrcAuth=WosAPI&KeyUT=WOS:000222526200005&DestLinkType=RelatedRecords&DestApp=WOS"},"citations":[{"db":"WOS","count":3}],"identifiers":{"doi":"10.3828/bhs.81.2.5","issn":"1475-3839"},"keywords":{"authorKeywords":[]}}]}}}}}}},"/documents/{uid}":{"get":{"tags":["Documents"],"summary":"Get Web of Science document by Accesssion Number (UID)","description":"Get Web of Science document by Accesssion Number (UID)","parameters":[{"name":"uid","in":"path","required":true,"description":"Web of Science unique identifier (Accession Number)","schema":{"type":"string","example":"WOS:000267144200002"}},{"name":"detail","in":"query","required":false,"schema":{"type":"string"},"description":"it will returns the full data by default, if detail=short it returns the limited data"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"},"example":{"uid":"WOS:000282418500002","title":"Wild bird indicators: using composite population trends of birds as measures of environmental health","types":["Article"],"sourceTypes":["Article"],"source":{"sourceTitle":"ORNITHOLOGICAL SCIENCE","publishYear":2010,"publishMonth":"JUN","volume":"9","issue":"1","pages":{"range":"3-22","begin":"3","end":"22","count":20}},"names":{"authors":[{"displayName":"Gregory, Richard D.","wosStandard":"Gregory, RD","researcherId":"AAG-1843-2020"}]},"links":{"record":"https://www.webofscience.com/api/gateway?GWVersion=2&SrcApp=&SrcAuth=WosAPI&KeyUT=WOS:000282418500002&DestLinkType=FullRecord&DestApp=WOS","citingArticles":"https://www.webofscience.com/api/gateway?GWVersion=2&SrcApp=&SrcAuth=WosAPI&KeyUT=WOS:000282418500002&DestLinkType=CitingArticles&DestApp=WOS","references":"https://www.webofscience.com/api/gateway?GWVersion=2&SrcApp=&SrcAuth=WosAPI&KeyUT=WOS:000282418500002&DestLinkType=CitedReferences&DestApp=WOS","related":"https://www.webofscience.com/api/gateway?GWVersion=2&SrcApp=&SrcAuth=WosAPI&KeyUT=WOS:000282418500002&DestLinkType=RelatedRecords&DestApp=WOS"},"citations":[{"db":"WOS","count":145}],"identifiers":{"doi":"10.2326/osj.9.3","issn":"1347-0558"},"keywords":{"authorKeywords":["Biodiversity targets","Birds","Environmental health","Population trends","Wild bird indicators"]}}}}}}}}},"servers":[{"url":"https://api.clarivate.com/apis/wos-starter/v1"},{"url":"https://api.clarivate.com/apis/wos-starter/v2"}],"components":{"securitySchemes":{"key":{"type":"apiKey","in":"header","name":"X-ApiKey"}},"schemas":{"Journal":{"type":"object","properties":{"id":{"type":"string","description":"Journal unique identifier"},"name":{"type":"string","description":"Journal full name"},"jcrTitle":{"type":"string","description":"Journal JCR abbreviation"},"isoTitle":{"type":"string","description":"Journal title in (ISO format)"},"issn":{"type":"string","description":"Journal ISSN"},"previousIssn":{"type":"array","description":"Previous ISSNs of the Journal (can be empty)","items":{"type":"string"}},"eIssn":{"type":"string","description":"Journal eISSN"},"links":{"type":"array","description":"URL to the Web of Science Products","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of URL that describes the product and page"},"url":{"type":"string","description":"URL of Web of Science Product"}}}}}},"JournalsList":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/Metadata"},"hits":{"type":"array","items":{"$ref":"#/components/schemas/Journal"}}}},"Document":{"type":"object","required":["uid"],"properties":{"uid":{"type":"string","description":"Web of Science Unique Identifier"},"title":{"type":"string","description":"Document title"},"types":{"type":"array","description":"Normalized Document Types","items":{"type":"string","description":"Normalized Document type"}},"sourceTypes":{"type":"array","description":"Source Document Types","items":{"type":"string","description":"Source Document type"}},"source":{"type":"object","description":"Web of Science document source metadata","properties":{"sourceTitle":{"type":"string","description":"Source title"},"publishYear":{"type":"integer","format":"int32","description":"Published Year"},"publishMonth":{"type":"string","description":"Published Month"},"volume":{"type":"string","description":"Volume"},"issue":{"type":"string","description":"Issue"},"supplement":{"type":"string","description":"Journal supplement"},"specialIssue":{"type":"string","description":"Journal special issue"},"articleNumber":{"type":"string","description":"Source Article Number"},"pages":{"type":"object","properties":{"range":{"type":"string","description":"Page range"},"begin":{"type":"string","description":"Page begin"},"end":{"type":"string","description":"Page end"},"count":{"type":"integer","format":"int32","description":"Number of pages"}}}}},"names":{"type":"object","properties":{"authors":{"type":"array","description":"Authors of document","items":{"$ref":"#/components/schemas/AuthorName"}},"contributors":{"type":"array","description":"Contributors sourced from the ORCID feed. This field is available only in the `/v2` API endpoints.","items":{"$ref":"#/components/schemas/AuthorName"}},"inventors":{"type":"array","items":{"$ref":"#/components/schemas/OtherName"}},"bookCorp":{"type":"array","items":{"$ref":"#/components/schemas/OtherName"}},"bookEditors":{"type":"array","items":{"$ref":"#/components/schemas/OtherName"}},"books":{"type":"array","items":{"$ref":"#/components/schemas/OtherName"}},"additionalAuthors":{"type":"array","items":{"$ref":"#/components/schemas/OtherName"}},"anonymous":{"type":"array","items":{"$ref":"#/components/schemas/OtherName"}},"assignees":{"type":"array","items":{"$ref":"#/components/schemas/OtherName"}},"corp":{"type":"array","items":{"$ref":"#/components/schemas/OtherName"}},"editors":{"type":"array","items":{"$ref":"#/components/schemas/OtherName"}},"investigators":{"type":"array","items":{"$ref":"#/components/schemas/OtherName"}},"sponsors":{"type":"array","items":{"$ref":"#/components/schemas/OtherName"}},"issuingOrganizations":{"type":"array","items":{"$ref":"#/components/schemas/OtherName"}}}},"links":{"type":"object","description":"Web of Science URLs","properties":{"record":{"type":"string"},"citingArticles":{"type":"string"},"references":{"type":"string"},"related":{"type":"string"}}},"citations":{"type":"array","description":"Times Cited","items":{"type":"object","properties":{"db":{"type":"string","description":"Web of Science Citation Database (collection) Abbreviation Name","example":"WOS"},"count":{"type":"integer","format":"int32","description":"Citation Count"}}}},"identifiers":{"type":"object","description":"Document and Source Identifiers","properties":{"doi":{"type":"string"},"issn":{"type":"string"},"eissn":{"type":"string"},"isbn":{"type":"string"},"eisbn":{"type":"string"},"pmid":{"type":"string"}}},"keywords":{"type":"object","description":"Author keywords","properties":{"authorKeywords":{"type":"array","items":{"type":"string"}}}}}},"DocumentsList":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/Metadata"},"hits":{"type":"array","items":{"$ref":"#/components/schemas/Document"}}}},"OtherName":{"type":"object","properties":{"displayName":{"type":"string","description":"Web of Science display name"}}},"AuthorName":{"type":"object","properties":{"displayName":{"type":"string","description":"Web of Science display name"},"wosStandard":{"type":"string","description":"Web of Science standard name"},"researcherId":{"type":"string","description":"Web of Science ResearcherID"}}},"Metadata":{"type":"object","description":"Information about total number of journals in the retrieve, number of recodrs on the page, and the page number","properties":{"page":{"type":"integer","format":"int32","description":"Page number (default is 1)"},"limit":{"type":"integer","format":"int32","description":"Number of records on a page (default is 10)."},"total":{"type":"integer","format":"int32","description":"Total number of records for the request."}}}}},"security":[{"key":[]}]}