ArxivRequest

Returns full specification of the request.

Conformig type decide and document configuration of the returned specification.

Returns URL for making arXiv API calls specified by the request.

Returns a new request changing the sorting criterion in requestSpecification.

Returns a new request changing the sorting order in requestSpecification.

Returns a new request changing the start index in requestSpecification.

Use to imlement paging. For example, if itemsPerPage == 20, the first page corresponds to startIndex == 0, the second page to startIndex == 40, the third page to startIndex == 60 etc.

ArxivReponse values can be used for getting various page indicies for given response.

From arxiv API manual:

In cases where the API needs to be called multiple times in a row, we encourage you to play nice and incorporate a 3 second delay in your code.

Because of speed limitations in our implementation of the API, the maximum number of results returned from a single call (itemsPerPage) is limited to 30000 in slices of at most 2000 at a time, using the itemsPerPage and startIndex query parameters.

For example to retrieve matches 6001-8000:

 term("electron", in: .any)
     .startIndex(6000)
     .itemsPerPage(8000)

Large result sets put considerable load on the server and also take a long time to render. We recommend to refine queries which return more than 1,000 results, or at least request smaller slices. For bulk metadata harvesting or set information, etc., the OAI-PMH interface is more suitable. A request with itemsPerPage > 30,000 will result in an HTTP 400 error code with appropriate explanation. A request for 30000 results will typically take a little over 2 minutes to return a response of over 15MB. Requests for fewer results are much faster and correspondingly smaller.

Returns a new request changing the number of items per single response page in requestSpecification.

From arxiv API manual:

In cases where the API needs to be called multiple times in a row, we encourage you to play nice and incorporate a 3 second delay in your code.

Because of speed limitations in our implementation of the API, the maximum number of results returned from a single call (itemsPerPage) is limited to 30000 in slices of at most 2000 at a time, using the itemsPerPage and startIndex parameters.

For example to retrieve matches 6001-8000:

 term("electron", in: .any)
     .startIndex(6000)
     .itemsPerPage(8000)

Large result sets put considerable load on the server and also take a long time to render. We recommend to refine queries which return more than 1,000 results, or at least request smaller slices. For bulk metadata harvesting or set information, etc., the OAI-PMH interface is more suitable. A request with itemsPerPage > 30000 will result in an HTTP 400 error code with appropriate explanation. A request for 30000 results will typically take a little over 2 minutes to return a response of over 15MB. Requests for fewer results are much faster and correspondingly smaller.

Uses provided session to download and parse articles specified by the request and delivers the result asynchronously.

Uses provided session to create and return a task described by the request.

The completion handler takes a single Result argument, which is either a succesfuly parsed ArxivResponse or an error, if one occurs. The error is either ArxivURLError, ArxivServerError, ArxivParserError or ArxivAPIError.

If multiple tasks are programatically run in a raw, a 3 seconds delay between the tasks is recomended by arxiv API manual.

Uses provided session to create and and run a task described by the request. Method returns the task after it starts running.

The completion handler takes a single Result argument, which is either a succesfuly parsed ArxivResponse, or an ArxivKitError, if one occurs.

If multiple tasks are programatically run in a raw, a 3 seconds delay between the tasks is recomended by arxiv API manual.

Uses provided session to create and return a task described by the request.

When the task completes, a result is assigned to property indicated bykeyPath on the provided object.

The result is either a succesfuly parsed ArxivResponse or an error, if one occurs. The error is either ArxivURLError, ArxivServerError, ArxivParserError or ArxivAPIError.

Uses provided session to create and and run a task described by the request. Method returns the task after it starts running.

The result is either a succesfuly parsed ArxivResponse or an error, if one occurs. The error is either ArxivURLError, ArxivServerError, ArxivParserError or ArxivAPIError.