| ncurl | R Documentation |
nano cURL - a minimalist http(s) client.
ncurl( url, convert = TRUE, follow = FALSE, method = NULL, headers = NULL, data = NULL, response = NULL, timeout = NULL, tls = NULL )
url |
the URL address. |
convert |
[default TRUE] logical value whether to attempt conversion of the received raw bytes to a character vector. Set to FALSE if downloading non-text data. |
follow |
[default FALSE] logical value whether to automatically follow redirects (not applicable for async requests). If FALSE, the redirect address is returned as response header 'Location'. |
method |
(optional) the HTTP method (defaults to 'GET' if not specified). |
headers |
(optional) a named list or character vector specifying the
HTTP request headers e.g. |
data |
(optional) character request data to be submitted. |
response |
(optional) a character vector or list specifying the response
headers to return e.g. |
timeout |
(optional) integer value in milliseconds after which the transaction times out if not yet complete. |
tls |
(optional) applicable to secure HTTPS sites only, a client TLS
Configuration object created by |
Named list of 3 elements:
$status - integer HTTP repsonse status code (200 - OK).
Use status_code for a translation of the meaning.
$headers - named list of response headers supplied in
'response', or NULL otherwise. If the status code is within the 300
range, i.e. a redirect, the response header 'Location' is automatically
appended to return the redirect address.
$data - the response body, as a character string if
'convert' = TRUE (may be further parsed as html, json, xml etc. as
required), or a raw byte vector if FALSE (use writeBin to
save as a file).
ncurl_aio for asynchronous http requests;
ncurl_session for persistent connections.
ncurl("https://postman-echo.com/get",
convert = FALSE,
response = c("date", "content-type"),
timeout = 1200L)
ncurl("https://postman-echo.com/put",
method = "PUT",
headers = list(Authorization = "Bearer APIKEY"),
data = "hello world",
timeout = 1500L)
ncurl("https://postman-echo.com/post",
method = "POST",
headers = c(`Content-Type` = "application/json"),
data = '{"key":"value"}',
timeout = 1500L)