This page documents the CORE API methods and API response codes.
Here you will find a documentation for CORE API. An introduction to the Web API is available here.
In order to use the API you will first need to register an API key. To request a new API key, please follow these instructions. The API key will be used to authorise your API requests. The API is available completely free of charge. To protect the service from excessive use, the number of request per unit of time is moderately restricted as described on this page.
This method searches the CORE database to find documents matching a query.
http://core.kmi.open.ac.uk/api/search/〈search_criteria〉
GET http://core.kmi.open.ac.uk/api/search/semantic%20web?api_key=ks8d74h5b4uj
GET http://core.kmi.open.ac.uk/api/search/title:%20(semantic%20web)?api_key=ks8d74h5b4uj
<?xml version="1.0" encoding="UTF-8"?>
<ListRecords>
<total_hits>
60124
</total_hits>
<record>
<header xmlns:core="http://core.kmi.open.ac.uk/api/doc">
<identifier>90157</identifier>
<core:repositoryIdentifier>1</core:repositoryIdentifier>
</header>
<metadata>
<oai_dc:dc xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:oai_dc="http://www.openarchives.org/OAI/2.0/oai_dc/"
xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/oai_dc/ http://www.openarchives.org/OAI/2.0/oai_dc.xsd">
<dc:creator>David Corsar, Pete Edwards, Nagendra Velaga, John Nelson, Jeff Pan</dc:creator>
<dc:title>Addressing the Challenges of Semantic Citizen-Sensing</dc:title>
<dc:description>Preprint</dc:description>
<dc:format>application/pdf</dc:format>
<dc:identifier>http://core.kmi.open.ac.uk/download/pdf/90157/1</dc:identifier>
<dc:identifier>http://core.kmi.open.ac.uk/display/90157</dc:identifier>
<dc:identifier>oai:aura.abdn.ac.uk:2164/2261</dc:identifier>
<dc:source>Aberdeen University Research Archive (AURA)</dc:source>
<dc:source>http://research.ict.csiro.au/conferences/ssn/ssn11/semantic_sensor_networks_2011.pdf</dc:source>
<dc:date>2011-10-23</dc:date>
</oai_dc:dc>
</metadata>
</record>
</ListRecords>
GET http://core.kmi.open.ac.uk/api/search/semantic%20web?format=json&api_key=ks8d74h5b4uj
{
"ListRecords":[
{
"total_hits":60124,
"record":{
"header":{
"identifier":"1589",
"core:repositoryIdentifier":"5"
},
"metadata":{
"oai_dc:dc":{
"oai_dc:ns":[
{
"xmlns:oai_dc":"http:\/\/www.openarchives.org\/OAI\/2.0\/oai_dc\/",
"xsi:schemaLocation":"http:\/\/www.openarchives.org\/OAI\/2.0\/oai_dc\/ http:\/\/www.openarchives.org\/OAI\/2.0\/oai_dc.xsd",
"xmlns:dc":"http:\/\/purl.org\/dc\/elements\/1.1\/"
}
],
"dc:creator":"Cameron Barnes and Belinda Tynan",
"dc:format":"application\/pdf",
"dc:source":"http:\/\/repository.alt.ac.uk\/724\/1\/ALT_J%2DVol15_No3_2007_The_adventures_of_Miranda_in_t.pdf",
"dc:date":"2007-09",
"dc:identifier":"oai:generic.eprints.org:724\/core5",
"dc:description":"This paper looks at the implications of Web 2.0 technologies for university teaching and ...",
"dc:title":"The adventures of Miranda in the brave new world: learning in a Web 2.0 millennium"
}
}
}
}
]
}Searches the CORE database for similar or duplicate documents to the specified document.
http://core.kmi.open.ac.uk/api/get/〈method〉/〈document_id〉
GET http://core.kmi.open.ac.uk/api/get/similar/5600?count=1&api_key=ks8d74h5b4uj
GET http://core.kmi.open.ac.uk/api/get/duplicate/5600?api_key=ks8d74h5b4uj
<?xml version="1.0" encoding="UTF-8"?>
<ListRecords>
<record>
<header>
<MuSim:AssociationMethod>core:CosineTFIDFSim</MuSim:AssociationMethod>
<core:repositoryIdentifier>124</core:repositoryIdentifier>
<MuSim:weight>0.357001</MuSim:weight>
<identifier>2767499</identifier>
</header>
<metadata>
<oai_dc:dc xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:oai_dc="http://www.openarchives.org/OAI/2.0/oai_dc/" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/oai_dc/ http://www.openarchives.org/OAI/2.0/oai_dc.xsd">
<dc:creator>Maren Duvendack</dc:creator>
<dc:format>application/pdf</dc:format>
<dc:source>University of East Anglia digital repository</dc:source>
<dc:source>https://ueaeprints.uea.ac.uk/18840/1/WP24.pdf</dc:source>
<dc:date>2010-08</dc:date>
<dc:identifier>http://core.kmi.open.ac.uk/download/pdf/2767499/124</dc:identifier>
<dc:identifier>http://core.kmi.open.ac.uk/display/2767499</dc:identifier>
<dc:identifier>oai:ueaeprints.uea.ac.uk:18840</dc:identifier>
<dc:title>Smoke and mirrors: evidence of microfinance impact from an evaluation of SEWA bank in India</dc:title>
</oai_dc:dc>
</metadata>
</record>
</ListRecords>
http://core.kmi.open.ac.uk/api/get/similar
POST http://core.kmi.open.ac.uk/api/get/similar
POST DATA text=Some%20text%20to%20be%20analyzed.&count=5&api_key=ks8d74h5b4uj
<?xml version="1.0" encoding="UTF-8"?>
<ListRecords>
<record>
<header>
<identifier>90157</identifier>
<core:repositoryIdentifier>1</core:repositoryIdentifier>
<MuSim:AssociationMethod>core:CosineTFIDFSim</MuSim:AssociationMethod>
<MuSim:weight>0.9952741</MuSim:weight>
</header>
<metadata>
<oai_dc:dc xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:oai_dc="http://www.openarchives.org/OAI/2.0/oai_dc/"
xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/oai_dc/ http://www.openarchives.org/OAI/2.0/oai_dc.xsd">
<dc:creator>David Corsar, Pete Edwards, Nagendra Velaga, John Nelson, Jeff Pan, School Aberdeen, dot Aberdeen, School Aberdeen and Geography Aberdeen</dc:creator>
<dc:title>Addressing the Challenges of Semantic Citizen-Sensing</dc:title>
<dc:description>Preprint</dc:description>
<dc:format>application/pdf</dc:format>
<dc:identifier>http://core.kmi.open.ac.uk/download/pdf/90157/1</dc:identifier>
<dc:identifier>http://core.kmi.open.ac.uk/display/90157</dc:identifier>
<dc:identifier>oai:aura.abdn.ac.uk:2164/2261</dc:identifier>
<dc:source>Aberdeen University Research Archive (AURA)</dc:source>
<dc:source>http://research.ict.csiro.au/conferences/ssn/ssn11/semantic_sensor_networks_2011.pdf</dc:source>
<dc:date>2011-10-23</dc:date>
</oai_dc:dc>
</metadata>
</record>
</ListRecords>
POST http://core.kmi.open.ac.uk/api/get_similar
POST DATA text=Some%20text%20to%20be%20analyzed.&response_format=json&api_key=ks8d74h5b4uj
{
"ListRecords":[
{
"record":{
"header":{
"MuSim:AssociationMethod":"core:CosineTFIDFSim",
"core:repositoryIdentifier":"143",
"MuSim:weight":"0.9998858",
"identifier":"1051754"
},
"metadata":{
"oai_dc:dc":{
"oai_dc:ns":[
{
"xmlns:oai_dc":"http:\/\/www.openarchives.org\/OAI\/2.0\/oai_dc\/",
"xsi:schemaLocation":"http:\/\/www.openarchives.org\/OAI\/2.0\/oai_dc\/ http:\/\/www.openarchives.org\/OAI\/2.0\/oai_dc.xsd",
"xmlns:dc":"http:\/\/purl.org\/dc\/elements\/1.1\/"
}
],
"dc:creator":"Dr. Chandra.E and Rajeswari .J",
"dc:format":"application\/pdf",
"dc:source":"http:\/\/www.ijest.info\/docs\/IJEST11-03-10-195.pdf",
"dc:date":"2011",
"dc:identifier":"oai:core.kmi.open.ac.uk:1051754",
"dc:description":"Data classification is an essential step in trying to safeguard one of the chief properties of an organization -its information. Data classification engages categorizing information to predefined levels. For every level, organizations must allocate different levels of security controls and restrict the number of employees or persons who can access the information. Data classification would be difficult in large organizations with significant content to estimate and classify. With the assistance of a data classification approach, organizations can recognize and implement proper setting for private access control and also can obtain decision based on the obtained result from data classification. Machine learning techniques are one of the best classification approaches in the recent development. Many techniques are available under the machine learning approaches and the most important objective of machine learning research is to automatically learn to identify complex patterns and make intelligent decisions based on data. In this paper, data classification usingmany Machine Learning Techniques has been discussed. This paper focuses on better Machine Learning Techniques which supports data classification are available in the literature.",
"dc:title":"A Survey on Data Classification using Machine Learning Techniques"
}
}
}
}
]
}
Returns the full-text of a selected CORE article in the PDF or plain text format.
http://core.kmi.open.ac.uk/api/download/〈format〉/〈document_id〉
GET http://core.kmi.open.ac.uk/api/download/pdf/35760?repository_id=41&api_key=ks8d74h5b4uj
GET http://core.kmi.open.ac.uk/api/download/text/35760?api_key=ks8d74h5b4uj
requested .pdf or .txt file
(ContentType = "application/pdf" or ContentType = "text/plain")
This method will attempt to detect the subject class for a given text fragment. It returns the class name. The method is experimental.
http://core.kmi.open.ac.uk/api/classify/text
POST http://core.kmi.open.ac.uk/api/classify/text
POST DATA text=Some%20text%20to%20be%20analyzed.
classification_token
(ContentType = "text/plain")Method will return URLs from text of article in CORE.
http://core.kmi.open.ac.uk/api/get/urls/〈document_id〉
GET http://core.kmi.open.ac.uk/api/get/urls/41214?api_key=ks8d74h5b4uj
<?xml version="1.0" encoding="UTF-8"?>
<urlList>
<url>http://iswc2005.semanticweb.org/</url>
<url>http://www.pwc.com/</url>
<url>http://knowledgeweb.semanticweb.org/</url>
<url>http://www.foaf-project.org/</url>
<url>http://www.friendster.com/</url>
<url>http://www.orkut.com/</url>
<url>https://www.linkedin.com/</url>
<url>http://www.thefacebook.com/</url>
<url>http://www.songbuddy.com/</url>
<url>http://www.autotrader.co.uk</url>
<url>http://www.rightmove.co.uk</url>
<url>http://challenge.semanticweb.org/</url>
<url>http://www.w3.org/DesignIssues/Semantic.html</url>
<url>http://www.w3.org/2003/Talks/1023-iswc-tbl/</url>
<url>http://www.w3.org/2004/Talks/0519-tbl-keynote/</url>
</urlList>
GET http://core.kmi.open.ac.uk/api/get/urls/41214?format=json&api_key=ks8d74h5b4uj
{
"urlList":[
{
"url":"http://iswc2005.semanticweb.org/"
},
{
"url":"http://www.pwc.com/"
},
{
"url":"http://knowledgeweb.semanticweb.org/"
},
{
"url":"http://www.foaf-project.org/"
},
{
"url":"http://www.friendster.com/"
},
{
"url":"http://www.orkut.com/"
},
{
"url":"https://www.linkedin.com/"
},
{
"url":"http://www.thefacebook.com/"
},
{
"url":"http://www.songbuddy.com/"
},
{
"url":"http://www.autotrader.co.uk"
},
{
"url":"http://www.rightmove.co.uk"
},
{
"url":"http://challenge.semanticweb.org/"
},
{
"url":"http://www.w3.org/DesignIssues/Semantic.html"
},
{
"url":"http://www.w3.org/2003/Talks/1023-iswc-tbl/"
},
{
"url":"http://www.w3.org/2004/Talks/0519-tbl-keynote/"
}
]
}Returns list of document citations (list of documents cited by the requested document).
http://core.kmi.open.ac.uk/api/get/citations/〈document_id〉
GET http://core.kmi.open.ac.uk/api/get/citations/44?api_key=ks8d74h5b4uj
<?xml version="1.0" encoding="UTF-8"?>
<citationList>
...
<citation>
<title>
Planning and Creating Eco-cities: Indicators as a Tool for Shaping Developing and Measuring Progress”, Local Environment,
</title>
<authors>
<author>E Kline</author>
</authors>
<date>2000</date>
<source_id>44</source_id>
<cited_doc_id/>
</citation>
<citation>
<title>Planning for Sustainability as a Learning Concept”</title>
<authors>
<author>T Meppem</author>
<author>R Gill</author>
</authors>
<date>1998</date>
<source_id>44</source_id>
<cited_doc_id>7321376</cited_doc_id>
</citation>
</citationList>
GET http://core.kmi.open.ac.uk/api/get/urls/41214?format=json&api_key=ks8d74h5b4uj
{
"citationList":[
{
"citation":{
"authors":[
{
"author":"E Kline"
}
],
"title":"Planning and Creating Eco-cities: Indicators as a Tool for Shaping Developing and Measuring Progress\u201D, Local Environment,",
"source_id":44,
"cited_doc_id":"",
"date":"2000"
}
},
{
"citation":{
"authors":[
{
"author":"T Meppem"
},
{
"author":"R Gill"
}
],
"title":"Planning for Sustainability as a Learning Concept\u201D",
"source_id":44,
"cited_doc_id":7321376,
"date":"1998"
}
}
]
}
Returns doi name of document requested
http://core.kmi.open.ac.uk/api/get/doi/〈document_id〉
GET http://core.kmi.open.ac.uk/api/get/doi/4869310?api_key=ks8d74h5b4uj
<?xml version="1.0" encoding="UTF-8"?>
<doi>
<identifier>4869310</identifier>
<doi_name>10.1146/annurev.bi.17.070148.003455</doi_name>
</doi>
GET http://core.kmi.open.ac.uk/api/get/doi/4869310?format=json&api_key=ks8d74h5b4uj
{
"doi": {
"doi_name": "10.1146\/annurev.bi.17.070148.003455",
"identifier": 4869310
}
}
This method will return information about repositories harvested by CORE including CORE id, name, base url and Open DOAR id.
http://core.kmi.open.ac.uk/api/stats/get_repositories
GET http://core.kmi.open.ac.uk/api/stats/get_repositories?api_key=ks8d74h5b4uj
<?xml version="1.0" encoding="UTF-8"?>
<repositories>
...
<repository>
<name>Electronics & Computer Science EPrints Service - University of Southampton</name>
<base_url>http://eprints.ecs.soton.ac.uk/perl/oai2</base_url>
<id>41</id>
<openDOAR_id>347</openDOAR_id>
</repository>
<repository>
<name>Enlighten</name>
<base_url>http://eprints.gla.ac.uk/perl/oai2</base_url>
<id>42</id>
<openDOAR_id>162</openDOAR_id>
</repository>
<repository>
<name>Eprints Archive - University of Portsmouth</name>
<base_url>http://eprints.libr.port.ac.uk/perl/oai2</base_url>
<id>43</id>
<openDOAR_id/>
</repository>
...
</repositories>
GET http://core.kmi.open.ac.uk/api/stats/get_repositories?format=json&api_key=ks8d74h5b4uj
{
"repositories":[
...
{
"repository":{
"id":41,
"openDOAR_id":"347",
"name":"Electronics & Computer Science EPrints Service - University of Southampton",
"base_url":"http:\/\/eprints.ecs.soton.ac.uk\/perl\/oai2"
}
},
{
"repository":{
"id":42,
"openDOAR_id":"162",
"name":"Enlighten",
"base_url":"http:\/\/eprints.gla.ac.uk\/perl\/oai2"
}
},
{
"repository":{
"id":43,
"openDOAR_id":"",
"name":"Eprints Archive - University of Portsmouth",
"base_url":"http:\/\/eprints.libr.port.ac.uk\/perl\/oai2"
}
},
...
]
}This method returns statistical information about about a selected CORE repository:
http://core.kmi.open.ac.uk/api/stats/get_rep_stats
GET http://core.kmi.open.ac.uk/api/stats/get_rep_stats?id=3&api_key=ks8d74h5b4uj
GET http://core.kmi.open.ac.uk/api/stats/get_rep_stats?id=1767&id_type=openDOAR_id&api_key=ks8d74h5b4uj
GET http://core.kmi.open.ac.uk/api/stats/get_rep_stats?id=http://aura.abdn.ac.uk/dspace-oai/request&id_type=url&api_key=ks8d74h5b4uj
<?xml version="1.0" encoding="UTF-8"?>
<repository>
<name>Aberdeen University Research Archive</name>
<base_url>http://aura.abdn.ac.uk/dspace-oai/request</base_url>
<id>1</id>
<openDOAR_id>1767</openDOAR_id>
<metadata_count>763</metadata_count>
<metadata_deleted_count>4</metadata_deleted_count>
<link_count>762</link_count>
<pdf_count>290</pdf_count>
<indexed_count>745</indexed_count>
</repository>
GET http://core.kmi.open.ac.uk/api/stats/get_rep_stats?id=3&format=json&api_key=ks8d74h5b4uj
GET http://core.kmi.open.ac.uk/api/stats/get_rep_stats?id=1767&id_type=openDOAR_id&format=json&api_key=ks8d74h5b4uj
GET http://core.kmi.open.ac.uk/api/stats/get_rep_stats?id=http://aura.abdn.ac.uk/dspace-oai/request&id_type=url&format=json&api_key=ks8d74h5b4uj
{
"repository":{
"id":1,
"pdf_count":290,
"link_count":762,
"metadata_count":763,
"metadata_deleted_count":4,
"openDOAR_id":1767,
"name":"Aberdeen University Research Archive",
"base_url":"http:\/\/aura.abdn.ac.uk\/dspace-oai\/request"
}
}Returns the following information on the CORE update history for a selected CORE repository:
http://core.kmi.open.ac.uk/api/stats/get_rep_update_history
GET http://core.kmi.open.ac.uk/api/stats/get_rep_update_history?id=3&api_key=ks8d74h5b4uj
GET http://core.kmi.open.ac.uk/api/stats/get_rep_update_history?id=1767&id_type=openDOAR_id&api_key=ks8d74h5b4uj
GET http://core.kmi.open.ac.uk/api/stats/get_rep_update_history?id=http://aura.abdn.ac.uk/dspace-oai/request&id_type=url&api_key=ks8d74h5b4uj
<?xml version="1.0" encoding="UTF-8"?>
<repository>
<name>Aberdeen University Research Archive</name>
<base_url>http://aura.abdn.ac.uk/dspace-oai/request</base_url>
<id>1</id>
<openDOAR_id>1767</openDOAR_id>
<updates>
<update>
<update_id>660</update_id>
<update_time>2012-07-23 11:45:51</update_time>
<update_type>index</update_type>
<update_status>unsuccessful</update_status>
</update>
<update>
<update_id>659</update_id>
<update_time>2012-07-23 11:38:09</update_time>
<update_type>index</update_type>
<update_status>successful</update_status>
</update>
<update>
<update_id>658</update_id>
<update_time>2012-07-20 15:20:26</update_time>
<update_type>citations</update_type>
<update_status>successful</update_status>
</update>
...
</updates>
</repository>
GET http://core.kmi.open.ac.uk/api/stats/get_rep_update_history?id=3&format=json&api_key=ks8d74h5b4uj
GET http://core.kmi.open.ac.uk/api/stats/get_rep_update_history?id=1767&id_type=openDOAR_id&format=json&api_key=ks8d74h5b4uj
GET http://core.kmi.open.ac.uk/api/stats/get_rep_update_history?id=http://aura.abdn.ac.uk/dspace-oai/request&id_type=url&format=json&api_key=ks8d74h5b4uj
{
"repository":{
"id":1,
"updates":[
{
"update":{
"update_status":"unsuccessful",
"update_id":660,
"update_time":"2012-07-23 11:45:51",
"update_type":"index"
}
},
{
"update":{
"update_status":"successful",
"update_id":659,
"update_time":"2012-07-23 11:38:09",
"update_type":"index"
}
},
{
"update":{
"update_status":"successful",
"update_id":658,
"update_time":"2012-07-20 15:20:26",
"update_type":"citations"
}
},
...
]
"openDOAR_id":1767,
"name":"Aberdeen University Research Archive",
"base_url":"http:\/\/aura.abdn.ac.uk\/dspace-oai\/request"
}
}Following is a list of all HTTP response codes that can be returned by CORE API.
To register a new API key to access the CORE API interface please send an email with the following information:
to p.knoth(at)open.ac.uk and include following text in subject: [CORE-API].
You will shortly receive new API key on the registered email.
The CORE API allows to make a number or requests per time. There is a different limit for each API method. The following table is showing the limits.
| Method | Limit |
| Similar & Duplicate | 10 requests per 10 seconds |
| Search | 10 requests per 10 seconds |
| Stats Methods | 10 requests per 10 seconds |
| URLs | 10 requests per 10 seconds |
| Classify | 2 requests per 10 seconds |
| Download | 2 requests per 10 seconds |