The core sttp client API comes in a single jar, with a transitive dependency on sttp model. This also includes a default, synchronous backend, which is based on Java’s HttpURLConnection.

To integrate with other parts of your application, you’ll often need to use an alternate backend (but what’s important is that the API remains the same!). See the section on backends for a short guide on which backend to choose, and a list of all implementations.

Using sbt

The basic dependency which provides the API and the default synchronous backend is:

"com.softwaremill.sttp.client3" %% "core" % "3.0.0-RC11"

sttp client is available for Scala 2.11, 2.12 and 2.13, and requires Java 8, as well as for Dotty (Scala 3) 0.27.

sttp client is also available for Scala.js 1.0. Note that not all modules are compatible and there are no backends that can be used on both. The last version compatible with Scala.js 0.6 was 2.2.1.

Using Ammonite

If you are an Ammonite user, you can quickly start experimenting with sttp by copy-pasting the following:

import $ivy.`com.softwaremill.sttp.client3::core:3.0.0-RC11`
import sttp.client3.quick._

Importing the quick object has the same effect as importing sttp.client3._, plus defining an implicit synchronous backend (implict val backend = HttpURLConnectionBackend()), so that sttp can be used right away.

If the default HttpURLConnectionBackend for some reason is insufficient, you can also use one based on OkHttp or HttpClient:

import $ivy.`com.softwaremill.sttp.client3::okhttp-backend:3.0.0-RC11`
import sttp.client3.okhttp.quick._


Working with sttp is most convenient if you import the sttp.client3 package entirely:

import sttp.client3._

This brings into scope the starting point for defining requests and some helper methods. All examples in this guide assume that this import is in place.

And that’s all you need to start using sttp client! To create and send your first request, import the above, type basicRequest. and see where your IDE’s auto-complete gets you! Here’s a simple request, using the synchronous backend:

import sttp.client3._

val backend = HttpURLConnectionBackend()
val response = basicRequest
  .body("Hello, world!")  


Next, read on about the how sttp client works or see some examples.