Low-Level API (Direct Mapping to Web API)

Both the low- and high-level APIs start off with an instance of SemanticScholarConnection, which handles managing the request rate.

julia> using SemanticScholar

julia> s2c = SemanticScholarConnection()
SemanticScholarConnection(Dates.DateTime[])

This s2c struct is then passed to all of the functions to make requests to the Semantic Scholar API.

paper_search(s2c, query; fields=["title"], limit=10, offset=0)

Make a paper search request to the S2 API (equivalent to "/paper/search" endpoint). The query must be "plaintext" with no special search filters.

paper_details(s2c, paper_id; fields)

Make a request for details about a paper to the S2 API (equivalent to "/paper/{paper_id}" endpoint).

paper_authors(s2c, paper_id; fields=[], offset=0, limit=500)

Make a paper authors request to the S2 API (equivalent to "/paper/{paper_id}/authors" endpoint).

paper_citations(s2c, paper_id; fields=[], offset=0, limit=500)

Make a paper citations request to the S2 API (equivalent to "/paper/{paper_id}/citations" endpoint).

paper_references(s2c, paper_id; fields=[], offset=0, limit=500)

Make a paper references request to the S2 API (equivalent to "/paper/{paper_id}/references" endpoint).

author_search(s2c, query; fields=["title"], limit=10, offset=0)

Make an author search request to the S2 API (equivalent to "/author/search" endpoint).

author_details(s2c, author_id; fields)

Make a request for author details to the S2 API (equivalent to "/author/{author_id}" endpoint).

author_papers(s2c, author_id; fields=[], offset=0, limit=500)

Make an author papers request to the S2 API (equivalent to "/author/{author_id}/papers" endpoint).

Paper Related