httr v1.4.2

0

Monthly downloads

0th

Percentile

Tools for Working with URLs and HTTP

Useful tools for working with HTTP organised by HTTP verbs (GET(), POST(), etc). Configuration functions make it easy to control additional request components (authenticate(), add_headers() and so on).

Readme

httr

CRAN status R build status Codecov test coverage

The aim of httr is to provide a wrapper for the curl package, customised to the demands of modern web APIs.

Key features:

  • Functions for the most important http verbs: GET(), HEAD(), PATCH(), PUT(), DELETE() and POST().

  • Automatic connection sharing across requests to the same website (by default, curl handles are managed automatically), cookies are maintained across requests, and a up-to-date root-level SSL certificate store is used.

  • Requests return a standard reponse object that captures the http status line, headers and body, along with other useful information.

    • Response content is available with content() as a raw vector (as = "raw"), a character vector (as = "text"), or parsed into an R object (as = "parsed"), currently for html, xml, json, png and jpeg.

    • You can convert http errors into R errors with stop_for_status().

  • Config functions make it easier to modify the request in common ways: set_cookies(), add_headers(), authenticate(), use_proxy(), verbose(), timeout(), content_type(), accept(), progress().

  • Support for OAuth 1.0 and 2.0 with oauth1.0_token() and oauth2.0_token(). The demo directory has eight OAuth demos: four for 1.0 (twitter, vimeo, withings and yahoo) and four for 2.0 (facebook, github, google, linkedin). OAuth credentials are automatically cached within a project.

httr wouldn't be possible without the hard work of the authors of curl and libcurl. Thanks! httr is inspired by http libraries in other languages, such as Resty, Requests and httparty.

Installation

To get the current released version from CRAN:

install.packages("httr")

To get the current development version from github:

# install.packages("devtools")
devtools::install_github("r-lib/httr")

Code of Conduct

Please note that the httr project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

Functions in httr

Name Description
PATCH Send PATCH request to a server.
BROWSE Open specified url in browser.
GET GET a url.
Token-class OAuth token objects.
POST POST file to a server.
PUT Send PUT request to server.
DELETE Send a DELETE request.
VERB VERB a url.
HEAD Get url HEADers.
RETRY Retry a request until it succeeds.
cookies Access cookies in a response.
authenticate Use http authentication.
http_type Extract the content type of a response
add_headers Add additional headers to a request.
oauth1.0_token Generate an oauth1.0 token.
http_status Give information on the status of a request.
get_callback Install or uninstall a callback function
httr_dr Diagnose common configuration problems
jwt_signature Generate a JWT signature given credentials.
httr-package httr makes http easy.
oauth_exchanger Walk the user through the OAuth2 dance without a local webserver.
content Extract content from a request.
oauth_listener Create a webserver to listen for OAuth callback.
cache_info Compute caching information for a response.
config Set curl options.
oauth_service_token Generate OAuth token for service accounts.
oauth2.0_token Generate an oauth2.0 token.
verbose Give verbose output.
oauth_signature Generate oauth signature.
modify_url Modify a url.
content_type Set content-type and accept headers.
handle_pool Maintain a pool of handles.
with_config Execute code with configuration set.
guess_media Guess the media type of a path from its extension.
sha1_hash SHA1 hash
sign_oauth Sign an OAuth request
httr_options List available options.
handle Create a handle tied to a particular host.
http_error Check for an http error.
parse_http_date Parse and print http dates.
response The response object.
parse_media Parse a media type.
http_condition Generate a classed http condition.
has_content Does the request have content associated with it?
headers Extract the headers from a response
insensitive Create a vector with case insensitive name matching.
progress Add a progress bar.
parse_url Parse and build urls according to RFC3986.
oauth_endpoint Describe an OAuth endpoint.
oauth_endpoints Popular oauth endpoints.
revoke_all Revoke all OAuth tokens in the cache.
init_oauth2.0 Retrieve OAuth 2.0 access token.
hmac_sha1 HMAC SHA1
init_oauth1.0 Retrieve OAuth 1.0 access token.
status_code Extract status code from response.
set_config Set (and reset) global httr configuration.
use_proxy Use a proxy to connect to the internet.
set_cookies Set cookies.
stop_for_status Take action on http error.
user_agent Set user agent.
timeout Set maximum request time.
oauth_app Create an OAuth application.
upload_file Upload a file with POST() or PUT().
oauth_callback The oauth callback url.
write_disk Control where the response body is written.
write_function S3 object to define response writer.
write_stream Process output in a streaming manner.
No Results!

Vignettes of httr

Name
api-packages.Rmd
quickstart.Rmd
secrets.Rmd
No Results!

Last month downloads

Details

License MIT + file LICENSE
URL https://httr.r-lib.org/, https://github.com/r-lib/httr
BugReports https://github.com/r-lib/httr/issues
VignetteBuilder knitr
Encoding UTF-8
RoxygenNote 7.1.1
NeedsCompilation no
Packaged 2020-07-20 14:19:08 UTC; hadley
Repository CRAN
Date/Publication 2020-07-20 23:40:04 UTC

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/httr)](http://www.rdocumentation.org/packages/httr)