/
core.ac.uk.json
1385 lines (1385 loc) · 61 KB
/
core.ac.uk.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"openapi": "3.0.0",
"info": {
"contact": { "x-twitter": "oacore" },
"description": "<p style=\"text-align: justify;\">You can use the CORE API to access the \n resources harvested and enriched by CORE. If you encounter any problems with the API, please <a href=\"/contact\">report them to us</a>.</p>\n\n<h2>Overview</h2>\n<p style=\"text-align: justify;\">The API is organised by resource type. The resources are <b>articles</b>, \n <b>journals</b> and <b>repositories</b> and are represented using JSON data format. Furthermore, \n each resource has a list of methods. The API also provides two global methods for accessing all resources at once.</p>\n\n<h2>Response format</h2>\n<p style=\"text-align: justify;\">Response for each query contains two fields: <b>status</b> and <b>data</b>.\n In case of an error status, the data field is empty. The data field contains a single object\n in case the request is for a specific identifier (e.g. CORE ID, CORE repository ID, etc.), or \n contains a list of objects, for example for search queries. In case of batch requests, the response\n is an array of objects, each of which contains its own <b>status</b> and <b>data</b> fields.\n For search queries the response contains an additional field <b>totalHits</b>, which is the \n total number of items which match the search criteria.</p>\n\n<h2>Search query syntax</h2>\n\n<p style=\"text-align: justify\">Complex search queries can be used in all of the API search methods.\n The query can be a simple string or it can be built using terms and operators described in Elasticsearch\n <a href=\"http://www.elastic.co/guide/en/elasticsearch/reference/1.4/query-dsl-query-string-query.html#query-string-syntax\">documentation</a>.\n The usable field names are <strong>title</strong>, <strong>description</strong>, <strong>fullText</strong>, \n <strong>authors</strong>, <strong>publisher</strong>, <strong>repositories.id</strong>, <strong>repositories.name</strong>, \n <strong>doi</strong>, <strong>oai</strong>, <strong>identifiers</strong> (which is a list of article identifiers including OAI, URL, etc.), <strong>language.name</strong> \n and <strong>year</strong>. Some example queries:\n</p>\n\n<ul style=\"margin-left: 30px;\">\n <li><p>title:psychology and language.name:English</p></li>\n <li><p>repositories.id:86 AND year:2014</p></li>\n <li><p>identifiers:\"oai:aura.abdn.ac.uk:2164/3837\" OR identifiers:\"oai:aura.abdn.ac.uk:2164/3843\"</p></li>\n <li><p>doi:\"10.1186/1471-2458-6-309\"</p></li>\n</ul>\n\n<h3>Retrieving the latest Articles</h3>\n<p style=\"text-align: justify\">\n You can retrieve the harvested items since specific dates using the following queries:\n</p>\n\n<ul style=\"margin-left: 30px;\">\n <li><p>repositoryDocument.metadataUpdated:>2017-02-10</p></li>\n <li><p>repositoryDocument.metadataUpdated:>2017-03-01 AND repositoryDocument.metadataUpdated:<2017-03-31</p></li> \n</ul>\n\n<h2>Sort order</h2>\n\n<p style=\"text-align: justify;\">For search queries, the results are ordered by relevance score. For batch \n requests, the results are retrieved in the order of the requests.</p>\n\n<h2>Parameters</h2>\n<p style=\"text-align: justify;\">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 \n the API key can be provided either as a query parameter or in the request header. If the API key \n is not provided, the API will return HTTP 401 error. You can register for an API key <a href=\"/services#api\">here</a>.</p>\n\n<h2>API methods</h2>",
"title": "CORE API v2",
"version": "2.0",
"x-apisguru-categories": ["open_data"],
"x-logo": { "url": "https://api.apis.guru/v2/cache/logo/https_twitter.com_oacore_profile_image.png" },
"x-origin": [
{
"converter": { "url": "https://github.com/lucybot/api-spec-converter", "version": "2.7.31" },
"format": "swagger",
"url": "http://core.ac.uk/api-v2/doc",
"version": "1.2"
}
],
"x-preferred": true,
"x-providerName": "core.ac.uk"
},
"security": [{ "apiKey": [] }],
"tags": [
{ "description": "Global operations", "name": "all" },
{ "description": "Operations for retrieving articles", "name": "articles" },
{ "description": "Operations for retrieving journals", "name": "journals" },
{ "description": "Operations for retrieving repositories", "name": "repositories" }
],
"paths": {
"/articles/dedup": {
"post": {
"description": "Method accepts values for several parameters and retrieves a JSON array of articles which have near duplicate content matching the input parameters' values. The response array contains ids of the near duplicate articles along with their relevance scores.",
"operationId": "nearDuplicateArticles",
"parameters": [
{
"description": "The DOI for which the duplicates will be identified",
"in": "query",
"name": "doi",
"required": false,
"schema": { "type": "string" }
},
{
"description": "Title to match when looking for duplicate articles. Only useful when either value for @year or @description is supplied.",
"in": "query",
"name": "title",
"required": false,
"schema": { "type": "string" }
},
{
"description": "Year the article was published. Only useful when value for @title is supplied. ",
"in": "query",
"name": "year",
"required": false,
"schema": { "type": "string" }
},
{
"description": "Abstract for an article based on which its duplicates will be found. Only useful when value for @title is supplied.",
"in": "query",
"name": "description",
"required": false,
"schema": { "type": "string" }
},
{
"description": "Full text for an article based on which its duplicates will be found.",
"in": "query",
"name": "fulltext",
"required": false,
"schema": { "type": "string" }
},
{
"description": "Article identifier for which the duplicates will be identified. Only useful when either values for @doi or (@title and @year) or (@title and @abstract) or @fulltext are supplied.",
"in": "query",
"name": "identifier",
"required": false,
"schema": { "type": "string" }
},
{
"description": "Limit the duplicates search to particular repository id. ",
"in": "query",
"name": "repositoryId",
"required": false,
"schema": { "type": "string" }
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArticleDedupResponse" } } }
},
"400": { "description": "Insufficient/Unsuitable input parameters." },
"401": { "description": "Invalid or no API key provided" },
"503": { "description": "Could not run the deduplication service at this time; please try again later." }
},
"summary": "Get all near duplicate articles",
"tags": ["articles"]
}
},
"/articles/get": {
"post": {
"description": "Method 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.",
"operationId": "getArticleByCoreIdBatch",
"parameters": [
{
"description": "Whether to retrieve the full article metadata or only the IDs. The default value is true",
"in": "query",
"name": "metadata",
"required": false,
"schema": { "type": "boolean", "default": true }
},
{
"description": "Whether to retrieve fulltexts of the articles. The default value is false",
"in": "query",
"name": "fulltext",
"required": false,
"schema": { "type": "boolean", "default": false }
},
{
"description": "Whether to retrieve citations found in the articles. The default value is false",
"in": "query",
"name": "citations",
"required": false,
"schema": { "type": "boolean", "default": false }
},
{
"description": "Whether to retrieve lists of similar articles. The default value is false. Because the similar articles are calculated on demand, setting this parameter to true might slightly slow down the response time",
"in": "query",
"name": "similar",
"required": false,
"schema": { "type": "boolean", "default": false }
},
{
"description": "Whether to retrieve CORE IDs of different versions of the articles. The default value is false",
"in": "query",
"name": "duplicate",
"required": false,
"schema": { "type": "boolean", "default": false }
},
{
"description": "Whether to retrieve lists of URLs of the article fulltexts. The default value is false",
"in": "query",
"name": "urls",
"required": false,
"schema": { "type": "boolean", "default": false }
},
{
"description": "Returns the records raw XML metadata from the original repository. The default value is false",
"in": "query",
"name": "faithfulMetadata",
"required": false,
"schema": { "type": "boolean", "default": false }
}
],
"requestBody": {
"content": { "application/json": { "schema": { "items": { "type": "integer" }, "type": "array" } } },
"description": "JSON array with CORE IDs of articles that need to be fetched",
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": { "items": { "$ref": "#/components/schemas/ArticleResponse" }, "type": "array" }
}
}
},
"400": { "description": "Missing or malformed JSON in request body" },
"401": { "description": "Invalid or no API key provided" },
"403": { "description": "Too many queries in request body" },
"429": { "description": "Too many requests in given amount of time" }
},
"summary": "Batch operation for retrieving articles by CORE ID",
"tags": ["articles"]
}
},
"/articles/get/{coreId}": {
"get": {
"description": "Method will retrieve an article based on given CORE ID.",
"operationId": "getArticleByCoreId",
"parameters": [
{
"description": "CORE ID of the article that needs to be fetched.",
"in": "path",
"name": "coreId",
"required": true,
"schema": { "type": "integer", "format": "int64" }
},
{
"description": "Whether to retrieve the full article metadata or only the ID. The default value is true.",
"in": "query",
"name": "metadata",
"required": false,
"schema": { "type": "boolean", "default": true }
},
{
"description": "Whether to retrieve full text of the article. The default value is false",
"in": "query",
"name": "fulltext",
"required": false,
"schema": { "type": "boolean", "default": false }
},
{
"description": "Whether to retrieve citations found in the article. The default value is false",
"in": "query",
"name": "citations",
"required": false,
"schema": { "type": "boolean", "default": false }
},
{
"description": "Whether to retrieve a list of similar articles. The default value is false. Because the similar articles are calculated on demand, setting this parameter to true might slightly slow down the response time",
"in": "query",
"name": "similar",
"required": false,
"schema": { "type": "boolean", "default": false }
},
{
"description": "Whether to retrieve a list of CORE IDs of different versions of the article. The default value is false",
"in": "query",
"name": "duplicate",
"required": false,
"schema": { "type": "boolean", "default": false }
},
{
"description": "Whether to retrieve a list of URLs from which the article can be downloaded. This can include links to PDFs as well as HTML pages. The default value is false",
"in": "query",
"name": "urls",
"required": false,
"schema": { "type": "boolean", "default": false }
},
{
"description": "Returns the records raw XML metadata from the original repository. The default value is false",
"in": "query",
"name": "faithfulMetadata",
"required": false,
"schema": { "type": "boolean", "default": false }
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArticleResponse" } } }
},
"400": { "description": "Invalid identifier supplied" },
"401": { "description": "Invalid or no API key provided" },
"429": { "description": "Too many requests in given amount of time" }
},
"summary": "Get article by CORE ID",
"tags": ["articles"]
}
},
"/articles/get/{coreId}/download/pdf": {
"get": {
"description": "Method will retrieve an article based on given CORE ID.",
"operationId": "getArticlePdfByCoreId",
"parameters": [
{
"description": "ID of article history that needs to be fetched",
"in": "path",
"name": "coreId",
"required": true,
"schema": { "type": "string" }
}
],
"responses": {
"200": { "description": "Successful operation" },
"401": { "description": "Invalid or no API key provided" },
"404": { "description": "No Article pdf found" },
"429": { "description": "Too many requests in given amount of time" }
},
"summary": "Get fulltext PDF by CORE ID",
"tags": ["articles"]
}
},
"/articles/get/{coreId}/history": {
"get": {
"description": "Method 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 the newest one to the oldest one.",
"operationId": "getArticleHistoryByCoreId",
"parameters": [
{
"description": "CORE ID of the article which history should be fetched",
"in": "path",
"name": "coreId",
"required": true,
"schema": { "type": "string" }
},
{
"description": "Which page of the history results should be retrieved. Can be any number betwen 1 and 100, default is 1 (first page).",
"in": "query",
"name": "page",
"required": false,
"schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 100, "default": 1 }
},
{
"description": "The number of results to return per page. Can be any number between 10 and 100, default is 10.",
"in": "query",
"name": "pageSize",
"required": false,
"schema": { "type": "integer", "format": "int32", "minimum": 10, "maximum": 100, "default": 10 }
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArticleHistoryResponse" } } }
},
"400": { "description": "Parameter invalid or out of bounds" },
"401": { "description": "Invalid or no API key provided" },
"429": { "description": "Too many requests in given amount of time" }
},
"summary": "Get article history by CORE ID",
"tags": ["articles"]
}
},
"/articles/search": {
"post": {
"description": "Method 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 queries. Method searches through all article fields (title, authors, subjects, identifiers, etc.).",
"operationId": "searchArticlesBatch",
"parameters": [
{
"description": "Whether to retrieve the full article metadata or only the ID. The default value is true.",
"in": "query",
"name": "metadata",
"required": false,
"schema": { "type": "boolean", "default": true }
},
{
"description": "Whether to retrieve full text of the article. The default value is false",
"in": "query",
"name": "fulltext",
"required": false,
"schema": { "type": "boolean", "default": false }
},
{
"description": "Whether to retrieve citations found in the article. The default value is false",
"in": "query",
"name": "citations",
"required": false,
"schema": { "type": "boolean", "default": false }
},
{
"description": "Whether to retrieve a list of similar articles. The default value is false. Because the similar articles are calculated on demand, setting this parameter to true might slightly slow down the response time",
"in": "query",
"name": "similar",
"required": false,
"schema": { "type": "boolean", "default": false }
},
{
"description": "Whether to retrieve a list of CORE IDs of different versions of the article. The default value is false",
"in": "query",
"name": "duplicate",
"required": false,
"schema": { "type": "boolean", "default": false }
},
{
"description": "Whether to retrieve a list of URLs from which the article can be downloaded. This can include links to PDFs as well as HTML pages. The default value is false",
"in": "query",
"name": "urls",
"required": false,
"schema": { "type": "boolean", "default": false }
},
{
"description": "Whether to retrieve the raw XML metadata of the article. The default value is false",
"in": "query",
"name": "faithfulMetadata",
"required": false,
"schema": { "type": "boolean", "default": false }
}
],
"requestBody": { "$ref": "#/components/requestBodies/SearchRequestArray" },
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": { "items": { "$ref": "#/components/schemas/ArticleSearchResponse" }, "type": "array" }
}
}
},
"400": { "description": "Missing or malformed JSON in request body" },
"401": { "description": "Invalid or no API key provided" },
"403": { "description": "Too many queries in request body" },
"429": { "description": "Too many requests in given amount of time" }
},
"summary": "Batch operation for search through articles",
"tags": ["articles"]
}
},
"/articles/search/{query}": {
"get": {
"description": "Searches through all articles and returns a JSON array with search results. Method searches through all article fields.",
"operationId": "searchArticles",
"parameters": [
{
"description": "The search query",
"in": "path",
"name": "query",
"required": true,
"schema": { "type": "integer", "format": "int64" }
},
{
"description": "Which page of the search results should be retrieved. Can be any number betwen 1 and 100, default is 1 (first page).",
"in": "query",
"name": "page",
"required": false,
"schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 100, "default": 1 }
},
{
"description": "The number of results to return per page. Can be any number between 10 and 100, default is 10.",
"in": "query",
"name": "pageSize",
"required": false,
"schema": { "type": "integer", "format": "int32", "minimum": 10, "maximum": 100, "default": 10 }
},
{
"description": "Whether to retrieve the full article metadata or only the ID. The default value is true.",
"in": "query",
"name": "metadata",
"required": false,
"schema": { "type": "boolean", "default": true }
},
{
"description": "Whether to retrieve full text of the article. The default value is false",
"in": "query",
"name": "fulltext",
"required": false,
"schema": { "type": "boolean", "default": false }
},
{
"description": "Whether to retrieve citations found in the article. The default value is false",
"in": "query",
"name": "citations",
"required": false,
"schema": { "type": "boolean", "default": false }
},
{
"description": "Whether to retrieve a list of similar articles. The default value is false. Because the similar articles are calculated on demand, setting this parameter to true might slightly slow down the response time",
"in": "query",
"name": "similar",
"required": false,
"schema": { "type": "boolean", "default": false }
},
{
"description": "Whether to retrieve a list of CORE IDs of different versions of the article. The default value is false",
"in": "query",
"name": "duplicate",
"required": false,
"schema": { "type": "boolean", "default": false }
},
{
"description": "Whether to retrieve a list of URLs from which the article can be downloaded. This can include links to PDFs as well as HTML pages. The default value is false",
"in": "query",
"name": "urls",
"required": false,
"schema": { "type": "boolean", "default": false }
},
{
"description": "Returns the records raw XML metadata from the original repository. The default value is false",
"in": "query",
"name": "faithfulMetadata",
"required": false,
"schema": { "type": "boolean", "default": false }
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArticleSearchResponse" } } }
},
"400": { "description": "Parameter invalid or out of bounds" },
"401": { "description": "Invalid or no API key provided" },
"429": { "description": "Too many requests in given amount of time" }
},
"summary": "Search through all documents",
"tags": ["articles"]
}
},
"/articles/similar": {
"post": {
"description": "Method 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, starting from the most similar.",
"operationId": "similarArticles",
"parameters": [
{
"description": "How many similar articles to retrieve at most. Can be any number betwen 1 and 100, default is 10",
"in": "query",
"name": "limit",
"required": false,
"schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 10 }
},
{
"description": "Whether to retrieve the full article metadata or only the IDs of the similar articles. The default value is true",
"in": "query",
"name": "metadata",
"required": false,
"schema": { "type": "boolean", "default": true }
},
{
"description": "Whether to retrieve fulltexts of the similar articles. The default value is false",
"in": "query",
"name": "fulltext",
"required": false,
"schema": { "type": "boolean", "default": false }
},
{
"description": "Whether to retrieve citations found in the articles. The default value is false",
"in": "query",
"name": "citations",
"required": false,
"schema": { "type": "boolean", "default": false }
},
{
"description": "Whether to retrieve lists of similar articles. The default value is false. Because the similar articles are calculated on demand, setting this parameter to true might slightly slow down the response time",
"in": "query",
"name": "similar",
"required": false,
"schema": { "type": "boolean", "default": false }
},
{
"description": "Whether to retrieve CORE IDs of different versions of the articles. The default value is false",
"in": "query",
"name": "duplicate",
"required": false,
"schema": { "type": "boolean", "default": false }
},
{
"description": "Whether to retrieve lists of URLs of the article fulltexts. The default value is false",
"in": "query",
"name": "urls",
"required": false,
"schema": { "type": "boolean", "default": false }
},
{
"description": "Whether to retrieve the raw XML metadata of the articles. The default value is false",
"in": "query",
"name": "faithfulMetadata",
"required": false,
"schema": { "type": "boolean", "default": false }
}
],
"requestBody": {
"content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimilarRequest" } } },
"description": "The text that requires similar articles to be calculated on",
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArticleSimilarResponse" } } }
},
"400": { "description": "Missing text in request body or parameter out of bounds or invalid parameter" },
"401": { "description": "Invalid or no API key provided" },
"429": { "description": "Too many requests in given amount of time" }
},
"summary": "Get articles by similarity to a text",
"tags": ["articles"]
}
},
"/journals/get": {
"post": {
"description": "Method accepts a JSON array of ISSNs and retrieves a list of journals.",
"operationId": "getJournalByIssnBatch",
"requestBody": {
"content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array" } } },
"description": "JSON array with ISSNs of journals that need to be fetched",
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": { "items": { "$ref": "#/components/schemas/JournalResponse" }, "type": "array" }
}
}
},
"400": { "description": "Missing or malformed JSON in request body" },
"401": { "description": "Invalid or no API key provided" },
"403": { "description": "Too many queries in request body" }
},
"summary": "Batch operation for retrieving journals by ISSN",
"tags": ["journals"]
}
},
"/journals/get/{issn}": {
"get": {
"description": "Returns a journal with given ISSN identifier.",
"operationId": "getJournalByIssn",
"parameters": [
{
"description": "ISSN identifier of journal that needs to be fetched.",
"in": "path",
"name": "issn",
"required": true,
"schema": { "type": "string" }
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalResponse" } } }
},
"400": { "description": "Invalid ISSN identifier supplied" },
"401": { "description": "Invalid or no API key provided" }
},
"summary": "Find journal by ISSN",
"tags": ["journals"]
}
},
"/journals/search": {
"post": {
"description": "Method 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 queries. Method searches through all journal fields (title, identifiers, subjects, language, rights and publisher).",
"requestBody": {
"content": {
"application/json": {
"schema": { "items": { "$ref": "#/components/schemas/SearchRequest" }, "type": "array" }
}
},
"description": "JSON array with search queries and parameters. One request can contain up to 100 queries.",
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": { "items": { "$ref": "#/components/schemas/JournalResponse" }, "type": "array" }
}
}
},
"400": { "description": "Missing or malformed JSON in request body" },
"401": { "description": "Invalid or no API key provided" },
"403": { "description": "Too many queries in request body" }
},
"summary": "Batch operation for search through journals",
"tags": ["journals"]
}
},
"/journals/search/{query}": {
"get": {
"description": "Searches through all journals and returns a JSON array of search results. Method searches through all journal fields (title, identifiers, subjects, language, rights and publisher).",
"parameters": [
{
"description": "Search query",
"in": "path",
"name": "query",
"required": true,
"schema": { "type": "string" }
},
{
"description": "Which page of the search results should be retrieved. Can be any number betwen 1 and 100, default is 1 (first page).",
"in": "query",
"name": "page",
"required": false,
"schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 100, "default": 1 }
},
{
"description": "The number of results to return per page. Can be any number between 10 and 100, default is 10.",
"in": "query",
"name": "pageSize",
"required": false,
"schema": { "type": "integer", "format": "int32", "minimum": 10, "maximum": 100, "default": 10 }
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalSearchResponse" } } }
},
"400": { "description": "Parameter invalid or out of bounds" },
"401": { "description": "Invalid or no API key provided" }
},
"summary": "Search through journals",
"tags": ["journals"]
}
},
"/repositories/get": {
"post": {
"description": "Method 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 request array. The maximum number of IDs in request is 100.",
"operationId": "getRepositoryByIdBatch",
"parameters": [
{
"description": "Whether to retrieve statistics about the repository. The default value is false",
"in": "query",
"name": "stats",
"required": false,
"schema": { "type": "boolean", "default": false }
},
{
"description": "Returns deposit history over time",
"in": "query",
"name": "depositHistory",
"required": false,
"schema": { "type": "boolean", "default": false }
},
{
"description": "Returns deposit history over time",
"in": "query",
"name": "depositHistoryCumulative",
"required": false,
"schema": { "type": "boolean", "default": false }
}
],
"requestBody": {
"content": { "application/json": { "schema": { "items": { "type": "integer" }, "type": "array" } } },
"description": "JSON array with CORE repository IDs of repositories that need to be fetched",
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": { "items": { "$ref": "#/components/schemas/RepositoryResponse" }, "type": "array" }
}
}
},
"400": { "description": "Missing or malformed JSON in request body" },
"401": { "description": "Invalid or no API key provided" },
"403": { "description": "Too many queries in request body" },
"429": { "description": "Too many requests in given amount of time" }
},
"summary": "Batch operation for retrieving repositories by CORE repository ID",
"tags": ["repositories"]
}
},
"/repositories/get/{repositoryId}": {
"get": {
"description": "Method will retrieve a repository based on given CORE repository ID.",
"operationId": "getRepositoryById",
"parameters": [
{
"description": "CORE repository ID of the article that needs to be fetched.",
"in": "path",
"name": "repositoryId",
"required": true,
"schema": { "type": "integer" }
},
{
"description": "Whether to retrieve statistics about the repository. The default value is false",
"in": "query",
"name": "stats",
"required": false,
"schema": { "type": "boolean", "default": false }
},
{
"description": "Returns deposit history over time",
"in": "query",
"name": "depositHistory",
"required": false,
"schema": { "type": "boolean", "default": false }
},
{
"description": "Returns deposit history over time",
"in": "query",
"name": "depositHistoryCumulative",
"required": false,
"schema": { "type": "boolean", "default": false }
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepositoryResponse" } } }
},
"400": { "description": "Invalid identifier supplied" },
"401": { "description": "Invalid or no API key provided" },
"429": { "description": "Too many requests in given amount of time" }
},
"summary": "Get repository by CORE repository ID",
"tags": ["repositories"]
}
},
"/repositories/search": {
"post": {
"description": "Method 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 the queries. Method searches through all repository fields.",
"parameters": [
{
"description": "Whether to retrieve statistics about the repository. The default value is false",
"in": "query",
"name": "stats",
"required": false,
"schema": { "type": "boolean", "default": false }
},
{
"description": "Returns deposit history over time",
"in": "query",
"name": "depositHistory",
"required": false,
"schema": { "type": "boolean", "default": false }
},
{
"description": "Returns deposit history over time",
"in": "query",
"name": "depositHistoryCumulative",
"required": false,
"schema": { "type": "boolean", "default": false }
}
],
"requestBody": { "$ref": "#/components/requestBodies/SearchRequestArray" },
"responses": {
"200": {
"description": "Successful operation",
"content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepositorySearchResponse" } } }
},
"400": { "description": "Missing or malformed JSON in request body" },
"401": { "description": "Invalid or no API key provided" },
"403": { "description": "Too many queries in request body" },
"429": { "description": "Too many requests in given amount of time" }
},
"summary": "Batch operation for searching through repositories",
"tags": ["repositories"]
}
},
"/repositories/search/{query}": {
"get": {
"description": "Searches through all repositories and returns a JSON array with search results. Method searches through all repository fields.",
"parameters": [
{
"description": "The search query",
"in": "path",
"name": "query",
"required": true,
"schema": { "type": "string" }
},
{
"description": "Which page of the search results should be retrieved. Can be any number betwen 1 and 100, default is 1 (first page).",
"in": "query",
"name": "page",
"required": false,
"schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 100, "default": 1 }
},
{
"description": "The number of results to return per page. Can be any number between 10 and 100, default is 10.",
"in": "query",
"name": "pageSize",
"required": false,
"schema": { "type": "integer", "format": "int32", "minimum": 10, "maximum": 100, "default": 10 }
},
{
"description": "Whether to retrieve statistics about the repository. The default value is false",
"in": "query",
"name": "stats",
"required": false,
"schema": { "type": "boolean", "default": false }
},
{
"description": "Returns deposit history over time",
"in": "query",
"name": "depositHistory",
"required": false,
"schema": { "type": "boolean", "default": false }
},
{
"description": "Returns deposit history over time",
"in": "query",
"name": "depositHistoryCumulative",
"required": false,
"schema": { "type": "boolean", "default": false }
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepositorySearchResponse" } } }
},
"400": { "description": "Parameter invalid or out of bounds" },
"401": { "description": "Invalid or no API key provided" },
"429": { "description": "Too many requests in given amount of time" }
},
"summary": "Search through all repositories",
"tags": ["repositories"]
}
},
"/search": {
"post": {
"description": "Method 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 searches through all resources and all fields. The results are ordered by relevance score and contain type of the relevant resource and its ID. Furthermore, the responses are oredered based on the order of the request items. The metadata of each resource need to be obtained through an appropriate method.",
"requestBody": {
"content": {
"application/json": {
"schema": { "items": { "$ref": "#/components/schemas/SearchRequest" }, "type": "array" }
}
},
"description": "JSON array with search queries and pagination parameters. One request can contain up to 100 queries",
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": { "items": { "$ref": "#/components/schemas/SearchAllResponse" }, "type": "array" }
}
}
},
"400": { "description": "Missing or malformed JSON in request body" },
"401": { "description": "Invalid or no API key provided" },
"403": { "description": "Too many queries in request body" },
"429": { "description": "Too many requests in given amount of time" }
},
"summary": "Batch operation for search through all resources",
"tags": ["all"]
}
},
"/search/{query}": {
"get": {
"description": "Searches through all resources and returns a JSON array with search results. Method searches through all resources and all fields. The results are ordered by relevance score and contain type of the relevant resource and its ID. The metadata of each resource need to be obtained through an appropriate method.",
"parameters": [
{
"description": "The search query",
"in": "path",
"name": "query",
"required": true,
"schema": { "type": "string" }
},
{
"description": "Which page of the search results should be retrieved. Can be any number betwen 1 and 100, default is 1 (first page).",
"in": "query",
"name": "page",
"required": false,
"schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 100, "default": 1 }
},
{
"description": "The number of results to return per page. Can be any number between 10 and 100, default is 10.",
"in": "query",
"name": "pageSize",
"required": false,
"schema": { "type": "integer", "format": "int32", "minimum": 10, "maximum": 100, "default": 10 }
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchAllResponse" } } }
},
"400": { "description": "Parameter invalid or out of bounds" },
"401": { "description": "Invalid or no API key provided" },
"429": { "description": "Too many requests in given amount of time" }
},
"summary": "Search through all resources",
"tags": ["all"]
}
}
},
"servers": [{ "url": "http://core.ac.uk/api-v2" }],
"components": {
"requestBodies": {
"SearchRequestArray": {
"content": {
"application/json": {
"schema": { "items": { "$ref": "#/components/schemas/SearchRequest" }, "type": "array" }
}
},
"description": "JSON array with search queries and parameters. One request can contain up to 100 queries",
"required": true
}
},
"securitySchemes": {
"apiKey": {
"description": "Your Api Key. Also accepts apiKey as a header",
"in": "query",
"name": "apiKey",
"type": "apiKey"
}
},
"schemas": {
"Article": {
"properties": {
"authors": { "description": "List of article authors", "items": { "type": "string" }, "type": "array" },
"citations": {
"description": "Citations found in the article",
"items": { "$ref": "#/components/schemas/Citation" },
"type": "array"
},
"contributors": {
"description": "List of article contributors",
"items": { "type": "string" },
"type": "array"
},
"datePublished": { "description": "Date article published", "type": "string" },
"description": { "description": "The abstract", "type": "string" },
"doi": { "description": "The DOI of the article", "type": "string" },
"downloadUrl": {
"description": "The download PDF URL which is displayed on our /display/[ArticleID] page",
"type": "string"
},
"fulltext": { "description": "Article full text", "type": "string" },
"fulltextIdentifier": { "description": "The URL to the fulltext", "type": "string" },
"fulltextUrls": {
"description": "URLs of the fulltext version of this article",
"items": { "type": "string" },
"type": "array"
},
"id": { "description": "Article ID", "type": "integer" },
"identifiers": {
"description": "List of document identifiers",
"items": { "type": "string" },
"type": "array"
},
"journals": {
"description": "List of journals this article belongs to",
"items": { "$ref": "#/components/schemas/ArticleJournal" },
"type": "array"