Core

CORE API v2

You can use the CORE API to access the resources harvested and enriched by CORE. If you encounter any problems with the API, please report them to us .…

Data & analytics#openapi#open-data

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

You can use the CORE API to access the
resources harvested and enriched by CORE. If you encounter any problems with the API, please report them to us .

Overview
The API is organised by resource type. The resources are articles ,
journals and repositories and are represented using JSON data format. Furthermore,
each resource has a list of methods. The API also provides two global methods for accessing all resources at once.

Response format
Response for each query contains two fields: status and data .
In case of an error status, the data field is empty. The data field contains a single object
in case the request is for a specific identifier (e.g. CORE ID, CORE repository ID, etc.), or
contains a list of objects, for example for search queries. In case of batch requests, the response
is an array of objects, each of which contains its own status and data fields.
For search queries the response contains an additional field totalHits , which is the
total number of items which match the search criteria.

Search query syntax

Complex search queries can be used in all of the API search methods.
The query can be a simple string or it can be built using terms and operators described in Elasticsearch
documentation .
The usable field names are title , description , fullText ,
authors , publisher , repositories.id , repositories.name ,
doi , oai , identifiers (which is a list of article identifiers including OAI, URL, etc.), language.name
and year . Some example queries:

title:psychology and language.name:English
repositories.id:86 AND year:2014
identifiers:"oai:aura.abdn.ac.uk:2164/3837" OR identifiers:"oai:aura.abdn.ac.uk:2164/3843"
doi:"10.1186/1471-2458-6-309"

Retrieving the latest Articles

You can retrieve the harvested items since specific dates using the following queries:

repositoryDocument.metadataUpdated:>2017-02-10
repositoryDocument.metadataUpdated:>2017-03-01 AND repositoryDocument.metadataUpdated:

Sort order

For search queries, the results are ordered by relevance score. For batch
requests, the results are retrieved in the order of the requests.

Parameters
The API methods allow different parameters to be passed. Additionally, there is an API key parameter which is common to all API methods. For all API methods
the API key can be provided either as a query parameter or in the request header. If the API key
is not provided, the API will return HTTP 401 error. You can register for an API key here .

API methods

Endpoints 18

all

  • POSTBatch operation for search through all resources/searchMethod accepts a JSON array of search queries. It searches through all resources and returns a JSON array with search results for each of the queries. Method…
  • GETSearch through all resources/search/:query?page=1&pageSize=10Searches through all resources and returns a JSON array with search results. Method searches through all resources and all fields. The results are ordered by…

articles

  • POSTGet all near duplicate articles/articles/dedup?doi=string&title=string&year=string&description=string&fulltext=string&identifier=string&repositoryId=stringMethod accepts values for several parameters and retrieves a JSON array of articles which have near duplicate content matching the input parameters' values.…
  • POSTBatch operation for retrieving articles by CORE ID/articles/get?metadata=true&fulltext=false&citations=false&similar=false&duplicate=false&urls=false&faithfulMetadata=falseMethod accepts a JSON array of CORE IDs and retrieves a list of articles. The response array is ordered based on the order of the IDs in the request array.
  • GETGet article by CORE ID/articles/get/:coreId?metadata=true&fulltext=false&citations=false&similar=false&duplicate=false&urls=false&faithfulMetadata=falseMethod will retrieve an article based on given CORE ID.
  • GETGet fulltext PDF by CORE ID/articles/get/:coreId/download/pdfMethod will retrieve an article based on given CORE ID.
  • GETGet article history by CORE ID/articles/get/:coreId/history?page=1&pageSize=10Method accepts a single CORE ID and returns a list of all historical versions of the article, which are stored in CORE database. The results are ordered from…
  • POSTBatch operation for search through articles/articles/search?metadata=true&fulltext=false&citations=false&similar=false&duplicate=false&urls=false&faithfulMetadata=falseMethod accepts a JSON array of search queries and parameters. It then searches through all articles and returns a JSON array of search results for each of the…
  • GETSearch through all documents/articles/search/:query?page=1&pageSize=10&metadata=true&fulltext=false&citations=false&similar=false&duplicate=false&urls=false&faithfulMetadata=falseSearches through all articles and returns a JSON array with search results. Method searches through all article fields.
  • POSTGet articles by similarity to a text/articles/similar?limit=10&metadata=true&fulltext=false&citations=false&similar=false&duplicate=false&urls=false&faithfulMetadata=falseMethod accepts a text and retrieves a JSON array of articles which are similar to the given text. The response array is ordered based on similarity score,…

journals

  • POSTBatch operation for retrieving journals by ISSN/journals/getMethod accepts a JSON array of ISSNs and retrieves a list of journals.
  • GETFind journal by ISSN/journals/get/:issnReturns a journal with given ISSN identifier.
  • POSTBatch operation for search through journals/journals/searchMethod accepts a JSON array of search queries and parameters. It then searches through all journals and returns a JSON array of search results for each of the…
  • GETSearch through journals/journals/search/:query?page=1&pageSize=10Searches through all journals and returns a JSON array of search results. Method searches through all journal fields (title, identifiers, subjects, language,…

repositories

  • POSTBatch operation for retrieving repositories by CORE repository ID/repositories/get?stats=false&depositHistory=false&depositHistoryCumulative=falseMethod accepts a JSON array of CORE repository IDs and retrieves a list of repositories. The response array is ordered based on the order of the IDs in the…
  • GETGet repository by CORE repository ID/repositories/get/:repositoryId?stats=false&depositHistory=false&depositHistoryCumulative=falseMethod will retrieve a repository based on given CORE repository ID.
  • POSTBatch operation for searching through repositories/repositories/search?stats=false&depositHistory=false&depositHistoryCumulative=falseMethod accepts a JSON array of search queries and parameters. It then searches through all repositories and returns a JSON array of search results for each of…
  • GETSearch through all repositories/repositories/search/:query?page=1&pageSize=10&stats=false&depositHistory=false&depositHistoryCumulative=falseSearches through all repositories and returns a JSON array with search results. Method searches through all repository fields.

API details

Base URL
http://core.ac.uk/api-v2
Authentication
An API key in the apiKey query parameter
Operations
18 operations on 18 pathsGET 9POST 9
Main resources
articles 8journals 4repositories 4all 2
Description format
Swagger 2.0, API version 2.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the CORE API v2 in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the CORE API v2 collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the apiKey query parameter. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Batch operation for search through all resources” (POST /search), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the CORE API v2?

You can use the CORE API to access the resources harvested and enriched by CORE. If you encounter any problems with the API, please report them to us .… It is listed under Data & analytics and has 18 endpoints.

Who publishes the CORE API v2?

It is listed from Core's public API description (an OpenAPI document), not published by Core on Swastik Codes. Anyone who controls core.ac.uk can claim the profile by adding a DNS TXT record.

What is the base URL of the CORE API v2?

Requests go to http://core.ac.uk/api-v2. Endpoint paths are added to this base URL.

How do I authenticate with the CORE API v2?

With an API key in the apiKey query parameter.

How many endpoints does the CORE API v2 have?

18 operations on 18 paths (9 GET, 9 POST). The largest groups are articles, journals, repositories, all.

Is forking the CORE API v2 free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.