Comment on page
API
Accessing OA.Report’s data
Our API allows you to search, use, and download data about research works. It's a RESTful JSON API powered by Elasticsearch.
get
https://api.oa.works/report/works/{doi}
Get a single work
Parameters
No parameters
Responses
200: OK
DOI: "10.1038/d41586-023-00175-1", subject: [ "Multidisciplinary" ], published_year: 2023, publisher: "Springer Science and Business Media LLC", published_date: "2023-01-20", title: "Confused by open-access policies? These tools can help", journal: "Nature", crossref_license_url_tdm: "https://www.springernature.com/gp/researchers/text-and-data-mining", crossref_license_url_vor: "https://www.springernature.com/gp/researchers/text-and-data-mining", crossref_is_oa: false, oa_status: "closed", has_repository_copy: false, has_oa_locations_embargoed: false, can_archive: true, version: "acceptedVersion", journal_oa_type: "transformative", oadoi_is_oa: false, is_oa: false,
get
https://api.oa.works/report/works/
Parameters
Path
count
String
shortcut to provide only the count of a queries response
terms/{key}
String
lists number of occurances of each string in the provided key
sum/{key}
String
adds all the values in the provided key
/keys
String
lists all available keys
Query
q
String
Allows you to filter results as desired. Your query (q) supports all elastic search terms such as AND, OR, NOT, brackets and wildcards (*).
sort
String
Comma-separated list of keys you want your list sorted by. The list is sorted by the order the keys are provided. Prepending
:desc to the key to reverse the sort order for that key (:asc is the default).size
String
The number of items to return
Default: 10
Limit: 10,000
from
Number
Where to start returning results from.
Default: 0
Limit: 10,000
includes
String
Comma-separated list of keys you want in your response.
Default: all
exclude
Comma-separated list of keys you don't want in your response.
Default: none
Responses
200: OK
get
https://api.oa.works/report/works.csv
Get a CSV of works
Parameters
Query
email*
String
Comma-separated list of emails you want to send a download link to your CSV
size
String
Default: 10
Format: number, or
all to provide all results (up to a max of 30,000)Responses
200: OK
https://static.oa.works/export/report_wroks_e6pdyvsqsseyo38jersne.csv
get
https://api.oa.works/report/orgs
Get a list of organizations
Parameters
No parameters
Responses
200: OK
Last modified 4mo ago