GET: GET a url.

In r-lib/httr: Tools for Working with URLs and HTTP

GET a url.

Description

GET a url.

Usage

GET(url = NULL, config = list(), ..., handle = NULL)

Arguments

url	the url of the page to retrieve
config	Additional configuration settings such as http authentication (authenticate()), additional headers (add_headers()), cookies (set_cookies()) etc. See config() for full details and list of helpers.
...	Further named parameters, such as query, path, etc, passed on to modify_url(). Unnamed parameters will be combined with config().
handle	The handle to use with this request. If not supplied, will be retrieved and reused from the handle_pool() based on the scheme, hostname and port of the url. By default httr requests to the same scheme/host/port combo. This substantially reduces connection time, and ensures that cookies are maintained over multiple requests to the same host. See handle_pool() for more details.

Value

A response() object.

RFC2616

The GET method means retrieve whatever information (in the form of an entity) is identified by the Request-URI. If the Request-URI refers to a data-producing process, it is the produced data which shall be returned as the entity in the response and not the source text of the process, unless that text happens to be the output of the process.

The semantics of the GET method change to a "conditional GET" if the request message includes an If-Modified-Since, If-Unmodified-Since, If-Match, If-None-Match, or If-Range header field. A conditional GET method requests that the entity be transferred only under the circumstances described by the conditional header field(s). The conditional GET method is intended to reduce unnecessary network usage by allowing cached entities to be refreshed without requiring multiple requests or transferring data already held by the client.

The semantics of the GET method change to a "partial GET" if the request message includes a Range header field. A partial GET requests that only part of the entity be transferred, as described in https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35 The partial GET method is intended to reduce unnecessary network usage by allowing partially-retrieved entities to be completed without transferring data already held by the client.

See Also

Other http methods: BROWSE(), DELETE(), HEAD(), PATCH(), POST(), PUT(), VERB()

Examples

GET("http://google.com/")
## Not run: 
GET("http://google.com/", path = "search")
GET("http://google.com/", path = "search", query = list(q = "ham"))

## End(Not run)

# See what GET is doing with httpbin.org
## Not run: 
url <- "http://httpbin.org/get"
GET(url)
GET(url, add_headers(a = 1, b = 2))
GET(url, set_cookies(a = 1, b = 2))
GET(url, add_headers(a = 1, b = 2), set_cookies(a = 1, b = 2))
GET(url, authenticate("username", "password"))
GET(url, verbose())

## End(Not run)

# You might want to manually specify the handle so you can have multiple
# independent logins to the same website.
## Not run: 
google <- handle("http://google.com")
GET(handle = google, path = "/")
GET(handle = google, path = "search")

## End(Not run)

r-lib/httr documentation built on Nov. 5, 2023, 7:26 a.m.