wreq

An easy-to-use HTTP client library.

http://www.serpentine.com/wreq

Version on this page:0.5.2.1
LTS Haskell 23.19:0.5.4.3
Stackage Nightly 2025-04-24:0.5.4.3
Latest on Hackage:0.5.4.3

See all snapshots wreq appears in

BSD-3-Clause licensed by Bryan O'Sullivan
Maintained by [email protected]
This version can be pinned in stack with:wreq-0.5.2.1@sha256:264a7ae6fca05c5457a65fb32a78bfdc40ec056ad61e5e122d692f8b18c016f8,5321

Module documentation for 0.5.2.1

wreq: a Haskell web client library Build Status

wreq is a library that makes HTTP client programming in Haskell easy.

Features

  • Simple but powerful lens-based API

  • Over 100 tests, and built on reliable libraries like http-client and lens

  • Session handling includes connection keep-alive and pooling, and cookie persistence

  • Automatic decompression

  • Powerful multipart form and file upload handling

  • Support for JSON requests and responses, including navigation of schema-less responses

  • Basic and OAuth2 bearer authentication

  • Amazon Web Services (AWS) request signing (Version 4)

  • AWS signing supports sending requests through the Runscope Inc. Traffic Inspector

Tutorials

See the tutorials for a quick-start.

Is it done?

No! See TODO.md for a rather long list of ideas.

Changes

-- markdown --

2018-03-01 0.5.2.1

  • Fixed some building issues with older versions

  • Removed dependency on cryptohash, using cryptonite instead

2018-01-01 0.5.2.0

  • Added some HistoriedResponse support

  • Deprecated withSession, added newSession (to be inline with upstream http-client)

  • Added same instances for Putable as for Postable (might be merged?)

  • Added getSessionCookieJar to get cookies from a Session

  • Fixed customPayloadMethod to follow the method (it was sometimes POST)

2017-12-23 0.5.1.1

  • Add awsSessionTokenAuth (in addition to the existing awsAuth) to support AWS Session Token Service (AWS STS) credentials. These look like regular AWS credentials but have an additional session token as a 3rd element. This mechanism is needed to be able to (a) use EC2 instance profiles, (b) make calls form AWS Lambda, (c) is useful for delegated role access (assumeRole within and across accounts), and (d) enables MFA-protected access scenarios. See tests/AWS/IAM.hs for a test and simple example.

2017-01-09 0.5.1.0

  • Add Session-specific version of Network.Wreq.customPayloadMethodWith

  • 8.2 GHC compatibility

2017-01-09 0.5.0.0

  • Compatible with http-client >= 0.5

  • This compatibility change required a small API change: checkStatus is now named checkResponse for compatibility with the http-client package

2015-05-10 0.4.0.0

  • Compatible with GHC 7.10.

  • New withAPISession and withSessionControl functions make talking to REST services more efficient.

  • Added support for AWS S3 virtual-host style URLs.

  • Added signing support for region specific calls to the AWS Security Token Service (AWS STS).

  • The introduction of AWS support accidentally introduced unwanted AWS headers and computation into all requests. This has been fixed.

2014-12-11 0.3.0.1

  • Bump lower bound on http-client to 0.3.0.1

2014-12-02 0.3.0.0

  • Support for Amazon Web Services request signing

  • New customMethod, customMethodWith functions allow use of arbitrary HTTP verbs

  • httpProxy, basicAuth, oauth2Bearer, oauth2Token: removed Maybe from result types, changed documentation to suggest use of (?~)

2014-08-25 0.2.0.0

  • Support for lens 4.4

2014-04-22 0.1.0.0

  • Initial release.