HTTPoison (HTTPoison v2.1.0) View Source

The HTTP client for Elixir.

The HTTPoison module can be used to issue HTTP requests and parse HTTP responses to arbitrary URLs.

iex> HTTPoison.get!("https://api.github.com")
%HTTPoison.Response{status_code: 200,
                    headers: [{"content-type", "application/json"}],
                    body: "{...}"}

It's very common to use HTTPoison in order to wrap APIs, which is when the HTTPoison.Base module shines. Visit the documentation for HTTPoison.Base for more information.

Under the hood, the HTTPoison module just uses HTTPoison.Base (as described in the documentation for HTTPoison.Base) without overriding any default function.

See request/5 for more details on how to issue HTTP requests

Link to this section Summary

Types

body()

headers()

method()

options()

params()

request()

url()

Functions

delete(url, headers \\ [], options \\ [])

Issues a DELETE request to the given url.

delete!(url, headers \\ [], options \\ [])

Issues a DELETE request to the given url, raising an exception in case of failure.

get(url, headers \\ [], options \\ [])

Issues a GET request to the given url.

get!(url, headers \\ [], options \\ [])

Issues a GET request to the given url, raising an exception in case of failure.

head(url, headers \\ [], options \\ [])

Issues a HEAD request to the given url.

head!(url, headers \\ [], options \\ [])

Issues a HEAD request to the given url, raising an exception in case of failure.

options(url, headers \\ [], options \\ [])

Issues an OPTIONS request to the given url.

options!(url, headers \\ [], options \\ [])

Issues a OPTIONS request to the given url, raising an exception in case of failure.

patch(url, body, headers \\ [], options \\ [])

Issues a PATCH request to the given url.

patch!(url, body, headers \\ [], options \\ [])

Issues a PATCH request to the given url, raising an exception in case of failure.

post(url, body, headers \\ [], options \\ [])

Issues a POST request to the given url.

post!(url, body, headers \\ [], options \\ [])

Issues a POST request to the given url, raising an exception in case of failure.

process_headers(headers) deprecated

Callback implementation for HTTPoison.Base.process_headers/1.

process_request_body(body)

Callback implementation for HTTPoison.Base.process_request_body/1.

process_request_headers(headers)

Callback implementation for HTTPoison.Base.process_request_headers/1.

process_request_options(options)

Callback implementation for HTTPoison.Base.process_request_options/1.

process_request_params(params)

Callback implementation for HTTPoison.Base.process_request_params/1.

process_request_url(url)

Callback implementation for HTTPoison.Base.process_request_url/1.

process_response(response)

Callback implementation for HTTPoison.Base.process_response/1.

process_response_body(body)

Callback implementation for HTTPoison.Base.process_response_body/1.

process_response_chunk(chunk)

Callback implementation for HTTPoison.Base.process_response_chunk/1.

process_response_headers(headers)

Callback implementation for HTTPoison.Base.process_response_headers/1.

process_response_status_code(status_code)

Callback implementation for HTTPoison.Base.process_response_status_code/1.

process_status_code(status_code) deprecated

Callback implementation for HTTPoison.Base.process_status_code/1.

process_url(url) deprecated

Callback implementation for HTTPoison.Base.process_url/1.

put(url, body \\ "", headers \\ [], options \\ [])

Issues a PUT request to the given url.

put!(url, body \\ "", headers \\ [], options \\ [])

Issues a PUT request to the given url, raising an exception in case of failure.

request(request)

Issues an HTTP request using an HTTPoison.Request struct.

request(method, url, body \\ "", headers \\ [], options \\ [])

Issues an HTTP request with the given method to the given url.

request!(method, url, body \\ "", headers \\ [], options \\ [])

Issues an HTTP request with the given method to the given url, raising an exception in case of failure.

start()

Starts HTTPoison and its dependencies.

stream_next(resp)

Requests the next message to be streamed for a given HTTPoison.AsyncResponse.

Link to this section Types

body()

Specs

body() :: HTTPoison.Base.body()

headers()

Specs

headers() :: HTTPoison.Base.headers()

method()

Specs

method() :: HTTPoison.Base.method()

options()

Specs

options() :: HTTPoison.Base.options()

params()

Specs

params() :: HTTPoison.Base.params()

request()

Specs

request() :: HTTPoison.Base.request()

url()

Specs

url() :: HTTPoison.Base.url()

Link to this section Functions

delete(url, headers \\ [], options \\ [])

Specs

delete(binary(), headers(), Keyword.t()) ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.t()}
  | {:error, HTTPoison.Error.t()}

Issues a DELETE request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

delete!(url, headers \\ [], options \\ [])

Specs

delete!(binary(), headers(), Keyword.t()) ::
  HTTPoison.Response.t()
  | HTTPoison.AsyncResponse.t()
  | HTTPoison.MaybeRedirect.t()

Issues a DELETE request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

get(url, headers \\ [], options \\ [])

Specs

get(binary(), headers(), Keyword.t()) ::
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
  | {:error, HTTPoison.Error.t()}

Issues a GET request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

get!(url, headers \\ [], options \\ [])

Specs

get!(binary(), headers(), Keyword.t()) ::
  HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()

Issues a GET request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

head(url, headers \\ [], options \\ [])

Specs

head(binary(), headers(), Keyword.t()) ::
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
  | {:error, HTTPoison.Error.t()}

Issues a HEAD request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

head!(url, headers \\ [], options \\ [])

Specs

head!(binary(), headers(), Keyword.t()) ::
  HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()

Issues a HEAD request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

options(url, headers \\ [], options \\ [])

Specs

options(binary(), headers(), Keyword.t()) ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.t()}
  | {:error, HTTPoison.Error.t()}

Issues an OPTIONS request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

options!(url, headers \\ [], options \\ [])

Specs

options!(binary(), headers(), Keyword.t()) ::
  HTTPoison.Response.t()
  | HTTPoison.AsyncResponse.t()
  | HTTPoison.MaybeRedirect.t()

Issues a OPTIONS request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

patch(url, body, headers \\ [], options \\ [])

Specs

patch(binary(), any(), headers(), Keyword.t()) ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.t()}
  | {:error, HTTPoison.Error.t()}

Issues a PATCH request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

patch!(url, body, headers \\ [], options \\ [])

Specs

patch!(binary(), any(), headers(), Keyword.t()) ::
  HTTPoison.Response.t()
  | HTTPoison.AsyncResponse.t()
  | HTTPoison.MaybeRedirect.t()

Issues a PATCH request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

post(url, body, headers \\ [], options \\ [])

Specs

post(binary(), any(), headers(), Keyword.t()) ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.t()}
  | {:error, HTTPoison.Error.t()}

Issues a POST request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

post!(url, body, headers \\ [], options \\ [])

Specs

post!(binary(), any(), headers(), Keyword.t()) ::
  HTTPoison.Response.t()
  | HTTPoison.AsyncResponse.t()
  | HTTPoison.MaybeRedirect.t()

Issues a POST request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

process_headers(headers)

This function is deprecated. Use process_response_headers/1 instead.

Specs

process_headers(list()) :: any()

Callback implementation for HTTPoison.Base.process_headers/1.

process_request_body(body)

Specs

process_request_body(body()) :: body()

Callback implementation for HTTPoison.Base.process_request_body/1.

process_request_headers(headers)

Specs

process_request_headers(headers()) :: headers()

Callback implementation for HTTPoison.Base.process_request_headers/1.

process_request_options(options)

Specs

process_request_options(options()) :: options()

Callback implementation for HTTPoison.Base.process_request_options/1.

process_request_params(params)

Specs

process_request_params(params()) :: params()

Callback implementation for HTTPoison.Base.process_request_params/1.

process_request_url(url)

Specs

process_request_url(url()) :: url()

Callback implementation for HTTPoison.Base.process_request_url/1.

process_response(response)

Specs

process_response(HTTPoison.Base.response()) :: any()

Callback implementation for HTTPoison.Base.process_response/1.

process_response_body(body)

Specs

process_response_body(binary()) :: any()

Callback implementation for HTTPoison.Base.process_response_body/1.

process_response_chunk(chunk)

Specs

process_response_chunk(binary()) :: any()

Callback implementation for HTTPoison.Base.process_response_chunk/1.

process_response_headers(headers)

Specs

process_response_headers(list()) :: any()

Callback implementation for HTTPoison.Base.process_response_headers/1.

process_response_status_code(status_code)

Specs

process_response_status_code(integer()) :: any()

Callback implementation for HTTPoison.Base.process_response_status_code/1.

process_status_code(status_code)

This function is deprecated. Use process_response_status_code/1 instead.

Specs

process_status_code(integer()) :: any()

Callback implementation for HTTPoison.Base.process_status_code/1.

process_url(url)

This function is deprecated. Use process_request_url/1 instead.

Specs

process_url(url()) :: url()

Callback implementation for HTTPoison.Base.process_url/1.

put(url, body \\ "", headers \\ [], options \\ [])

Specs

put(binary(), any(), headers(), Keyword.t()) ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.t()}
  | {:error, HTTPoison.Error.t()}

Issues a PUT request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

put!(url, body \\ "", headers \\ [], options \\ [])

Specs

put!(binary(), any(), headers(), Keyword.t()) ::
  HTTPoison.Response.t()
  | HTTPoison.AsyncResponse.t()
  | HTTPoison.MaybeRedirect.t()

Issues a PUT request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

request(request)

Specs

request(HTTPoison.Request.t()) ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.t()}
  | {:error, HTTPoison.Error.t()}

Issues an HTTP request using an HTTPoison.Request struct.

This function returns {:ok, response}, {:ok, async_response}, or {:ok, maybe_redirect} if the request is successful, {:error, reason} otherwise.

Redirect handling

If the option :follow_redirect is given, HTTP redirects are automatically follow if the method is set to :get or :head and the response's status_code is 301, 302 or 307.

If the method is set to :post, then the only status_code that get's automatically followed is 303.

If any other method or status_code is returned, then this function returns a returns a {:ok, %HTTPoison.MaybeRedirect{}} containing the redirect_url for you to re-request with the method set to :get.

Examples

request = %HTTPoison.Request{
  method: :post,
  url: "https://my.website.com",
  body: "{\"foo\": 3}",
  headers: [{"Accept", "application/json"}]
}

request(request)

request(method, url, body \\ "", headers \\ [], options \\ [])

Specs

request(method(), binary(), any(), headers(), Keyword.t()) ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.t()}
  | {:error, HTTPoison.Error.t()}

Issues an HTTP request with the given method to the given url.

This function is usually used indirectly by get/3, post/4, put/4, etc

Args:

method - HTTP method as an atom (:get, :head, :post, :put, :delete, etc.)
url - target url as a binary string or char list
body - request body. See more below
headers - HTTP headers as an orddict (e.g., [{"Accept", "application/json"}])
options - Keyword list of options

Body: see type HTTPoison.Request

Options: see type HTTPoison.Request

This function returns {:ok, response}, {:ok, async_response}, or {:ok, maybe_redirect} if the request is successful, {:error, reason} otherwise.

Redirect handling

If the option :follow_redirect is given, HTTP redirects are automatically follow if the method is set to :get or :head and the response's status_code is 301, 302 or 307.

If the method is set to :post, then the only status_code that get's automatically followed is 303.

Examples

request(:post, "https://my.website.com", "{\"foo\": 3}", [{"Accept", "application/json"}])

request!(method, url, body \\ "", headers \\ [], options \\ [])

Specs

request!(method(), binary(), any(), headers(), Keyword.t()) ::
  HTTPoison.Response.t()
  | HTTPoison.AsyncResponse.t()
  | HTTPoison.MaybeRedirect.t()

Issues an HTTP request with the given method to the given url, raising an exception in case of failure.

request!/5 works exactly like request/5 but it returns just the response in case of a successful request, raising an exception in case the request fails.

start()

Starts HTTPoison and its dependencies.

stream_next(resp)

Specs

stream_next(HTTPoison.AsyncResponse.t()) ::
  {:ok, HTTPoison.AsyncResponse.t()} | {:error, HTTPoison.Error.t()}

Requests the next message to be streamed for a given HTTPoison.AsyncResponse.

See request!/5 for more detailed information.