-
Notifications
You must be signed in to change notification settings - Fork 6
JSON API (legacy schema)
SCOAP3 API allows search and harvest of all articles metadata and its fulltext files. The limitation is that maximum number of articles metadata downloaded per request is 10; this can be changed when using the unlimited API as a registered partner. All data are exported in JSON format.
Base URL for SCOAP3 API is: https://backend.scoap3.org/api/search/records/?format=json. To perform an easy search one can use the search parameter to specify a single search pattern.
Example URL: https://backend.scoap3.org/api/search/records/?format=json&search=higgs
| Parameter | Description |
|---|---|
| search | pattern |
| size | number of returned results (max 10 for not authorized queries) |
| page_size | number of page in results |
The search parameter contains a query search pattern. Pattern can be a single search term, contain a logical operator AND, OR, use any of metadata JSON fields or use additional filters.
Examples of search patterns:
Bellow the metadata of record 43025 can be seen.
The schema describing the metadata used to export data from the repository is available here: http://repo.scoap3.org/schemas/hep.json.
Most of the JSON fields are self explanatory but the summary can be found below.
| Field | Description |
|---|---|
| abstract | list of abstracts of an article source - source of the abstract value - content of the abstract |
| acquisition_source | information about article origin and delivery date - date of acquisition delivered by publisher method - name of harvester source - source of the article submission_number - unique ID of harvest |
| arxiv_eprints (optional) |
list of arXiv IDs value - arXiv ID categories - arXiv categories. First element is always the primary category, followed by the secondary categories (if any). |
| authors | information about articles authors full-name - full name of the author given-names - given names of the author orcid (optional) - ORCID number raw-name (optional) - authors name as in the metadata surname - authors surname |
| authors.affiliations | list of authors affiliations country - extracted country of affiliation value - affiliation name as in the metadata |
| collaborations (optional) | value - Collaboration name as it appears on the paper |
| control_number | unique ID of the article in SCOAP3 repository (former recid) |
| copyright | article copyright information holder - holder of copyright material statement - statement as in the metadata year - year of the copyright |
| dois | list of DOIs assigned to this article |
| imprints | publication information date - publication date publisher - name of publisher |
| license | articles license information license - type of license url - link to full license information |
| page_nr (optional) | number of pages |
| publication_info | bibliographic information about article material (optional) - type of the paper: article, corrigendum, addendum, erratum artid (optional) - publishers article ID journal_issue (optional) - issue of journal journal_title - title of journal journal_volume (optional) - volume of journal note (optional) - publication notes page_end (optional) - ending page of article page_start (optional) - starting page of article pubinfo_freetext (optional) - publication infomrmation year - publication year |
| record_creation_date | creation date of the record in the repository |
| titles | list of titles available for the article source - source of the title subtitle title |
| _files | fulltext files attached to the record bucket - virtual location of file checksum filetype key - file name size - file size in bytes version_id - internal identifier for file version |
It is possible to get only a subset of available fields using the fields parameter. All above mentioned fields and subfields can be used. Multiple fields have to be separated by a comma (,).
Examples:
- https://backend.scoap3.org/api/search/article/?format=json&fields=authors: to query only the control numbers
Files can be downloaded one-by-one only. Links to files can be constructed in the following way: https://scoap3-prod-backend.s3.cern.ch/media/files/ + key
Links (for the same record as in the example) will look like this:
-
Repository (Legacy)
-
Repository (New)