httr v1.4.0

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

Travis build status Codecov test coverage CRAN status

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")

Functions in httr

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

Include our badge in your README

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