Getting to Know the Laravel HTTP Client

Last updated on by

Getting to Know the Laravel HTTP Client image

Laravel has an HTTP client that provides a minimal API around the popular Guzzle HTTP client. If you missed the news, let’s walk through some of the basics and features of this new client.

Guzzle is a powerful HTTP client, but the 80% use-case feels complicated when trying to make a simple HTTP GET or getting data back from a JSON API.

Highlight Features

At a glance, here are my favorite features the Laravel Http client provides:

  • Chain-able Request setup
  • Easy access to JSON response data
  • No boilerplate setup to make a simple request
  • Retrying failed requests
  • Convenience methods around authentication headers (basic, digest, bearer)
  • Test fakes and test inspections

For more complicated HTTP client work, you may have to use Guzzle directly, but I suspect that Laravel HTTP has everything that you’d need for most of your projects.

Basic Usage

Here’s the most basic usage you can expect using Laravel’s HTTP client:

use Illuminate\Support\Facades\Http;
 
$response = Http::get('https://laravel.com');
 
// Get the response body
$response->body();
 
$response = Http::get( 'https://api.github.com/users/paulredmond/gists' );
 
// Array of data from the JSON response
$data = $response->json();

Accessing Data

There are a few ways you can access data from JSON responses: the json() method and ArrayAccess:

// Access the response data via `json()`
$data = $response->json();
$data['username'];
 
// Array access from the Response object
Http::get( 'https://api.github.com/users/paulredmond/gists' )['username'];
 
// Return the response object and access directly
$response = Http::get('...');
$response['username'];

Error Handling

One thing that can get confusing and complicated with Guzzle is continually having to wrap calls in a try/catch block, or creating a mini-abstraction on every project to handle this for you.

Laravel catches 400 and 500 level responses and provides methods you can use to determine if anything bad happened during the response:

$response = Http::get( 'https://api.github.com/users/paulredmond/gists' );
 
// Boolean checks on the response
$response->ok() : bool;
$response->clientError(): bool;
$response->successful() : bool;
$response->serverError() : bool;
$response->clientError() : bool;

Timeouts

After reading that Laravel handles client and server exceptions, it wasn’t obvious to me at first that timeouts will cause an exception. The default timeout is rather long; however, Laravel HTTP allows you to define it yourself (in seconds) with the convenient timeout() method:

$response = Http::timeout(5)
->get( 'https://ffdsafdsafdsafas.com' );
 
// Illuminate\Http\Client\ConnectionException:
// cURL error 28: Connection timed out after 5005 milliseconds

Learn More

Check out our tutorial on 5 Tips and Tricks for working with the Laravel HTTP Client and the Laravel 7 HTTP Client Documentation. I’d also encourage you to check out the classes in Illuminate/Http—its quite a simple, elegant API which feels intuitive to use.

Paul Redmond photo

Staff writer at Laravel News. Full stack web developer and author.

Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.

image
Tinkerwell

Version 4 of Tinkerwell is available now. Get the most popular PHP scratchpad with all its new features and simplify your development workflow today.

Visit Tinkerwell
Laravel Forge logo

Laravel Forge

Easily create and manage your servers and deploy your Laravel applications in seconds.

Laravel Forge
Tinkerwell logo

Tinkerwell

The must-have code runner for Laravel developers. Tinker with AI, autocompletion and instant feedback on local and production environments.

Tinkerwell
No Compromises logo

No Compromises

Joel and Aaron, the two seasoned devs from the No Compromises podcast, are now available to hire for your Laravel project. ⬧ Flat rate of $7500/mo. ⬧ No lengthy sales process. ⬧ No contracts. ⬧ 100% money back guarantee.

No Compromises
Kirschbaum logo

Kirschbaum

Providing innovation and stability to ensure your web application succeeds.

Kirschbaum
Shift logo

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift
Bacancy logo

Bacancy

Supercharge your project with a seasoned Laravel developer with 4-6 years of experience for just $2500/month. Get 160 hours of dedicated expertise & a risk-free 15-day trial. Schedule a call now!

Bacancy
LoadForge logo

LoadForge

Easy, affordable load testing and stress tests for websites, APIs and databases.

LoadForge
Paragraph logo

Paragraph

Manage your Laravel app as if it was a CMS – edit any text on any page or in any email without touching Blade or language files.

Paragraph
Lucky Media logo

Lucky Media

Bespoke software solutions built for your business. We ♥ Laravel

Lucky Media
Lunar: Laravel E-Commerce logo

Lunar: Laravel E-Commerce

E-Commerce for Laravel. An open-source package that brings the power of modern headless e-commerce functionality to Laravel.

Lunar: Laravel E-Commerce
DocuWriter.ai logo

DocuWriter.ai

Save hours of manually writing Code Documentation, Comments & DocBlocks, Test suites and Refactoring.

DocuWriter.ai
Rector logo

Rector

Your partner for seamless Laravel upgrades, cutting costs, and accelerating innovation for successful companies

Rector

The latest

View all →
Non-backed Enums in Database Queries and a withSchedule() bootstrap method in Laravel 11.1 image

Non-backed Enums in Database Queries and a withSchedule() bootstrap method in Laravel 11.1

Read article
Laravel Pint --bail Flag image

Laravel Pint --bail Flag

Read article
Laravel Herd for Windows is now released! image

Laravel Herd for Windows is now released!

Read article
The Laravel Worldwide Meetup is Today image

The Laravel Worldwide Meetup is Today

Read article
Cache Routes with Cloudflare in Laravel image

Cache Routes with Cloudflare in Laravel

Read article
Learn how to manage timezones in your Laravel Apps image

Learn how to manage timezones in your Laravel Apps

Read article