docs.rodeo

MDN Web Docs mirror

HTTP range requests

{{HTTPSidebar}} 

An HTTP {{HTTPHeader("Range")}}  request asks the server to send parts of a resource back to a client. Range requests are useful for various clients, including media players that support random access, data tools that require only part of a large file, and download managers that let users pause and resume a download.

Checking if a server supports partial requests

If an HTTP response includes the {{HTTPHeader("Accept-Ranges")}}  header with any value other than none, the server supports range requests. If responses omit the Accept-Ranges header, it indicates the server doesn’t support partial requests. If range requests are not supported, applications can adapt to this condition; for instance, download managers can disable pause buttons that relied on range requests to resume a download.

To check if a server supports range requests, you can issue a {{HTTPMethod("HEAD")}}  request to inspect headers without requesting the resource in full. If you use curl, you can use the -I flag to make a HEAD request:

curl -I https://i.imgur.com/z4d4kWk.jpg

This will produce the following HTTP request:

HEAD /z4d4kWk.jpg HTTP/2
Host: i.imgur.com
User-Agent: curl/8.7.1
Accept: */*

The response only contains headers and doesn’t include a response body:

HTTP/2 200
content-type: image/jpeg
last-modified: Thu, 02 Feb 2017 11:15:53 GMT
…
accept-ranges: bytes
content-length: 146515

In this response, Accept-Ranges: bytes indicates that ‘bytes’ can be used as units to define a range (currently, no other unit is possible). The {{HTTPHeader("Content-Length")}}  header is also helpful as it indicates the total size of the image if you were to make the same request using the GET method instead.

Requesting a specific range from a server

If the server supports range requests, you can specify which part (or parts) of the document you want the server to return by including the {{HTTPHeader("Range")}}  header in a HTTP request.

Single part ranges

We can request a single range from a resource using curl for illustration. The -H option appends a header line to the request, which in this case is the Range header requesting the first 1024 bytes. The last option is --output - which will allow printing the binary output to the terminal:

curl https://i.imgur.com/z4d4kWk.jpg -i -H "Range: bytes=0-1023" --output -

The issued request looks like this:

GET /z4d4kWk.jpg HTTP/2
Host: i.imgur.com
User-Agent: curl/8.7.1
Accept: */*
Range: bytes=0-1023

The server responds with a {{HTTPStatus("206", "206 Partial Content")}}  status:

HTTP/2 206
content-type: image/jpeg
content-length: 1024
content-range: bytes 0-1023/146515
…

(binary content)

The {{HTTPHeader("Content-Length")}}  header indicates the size of the requested range, not the full size of the image. The {{HTTPHeader("Content-Range")}}  response header indicates where this partial message belongs within the full resource.

Multipart ranges

The {{HTTPHeader("Range")}}  header also allows you to get multiple ranges at once in a multipart document. The ranges are separated by a comma.

curl http://www.example.com -i -H "Range: bytes=0-50, 100-150"

The server responds with the {{HTTPStatus("206", "206 Partial Content")}}  status as shown below. The response contains a {{HTTPHeader("Content-Type")}}  header, indicating that a multipart byterange follows. The boundary string (3d6b6a416f9b5 in this case) separates the body parts, each of which has its own Content-Type and Content-Range fields:

HTTP/1.1 206 Partial Content
Content-Type: multipart/byteranges; boundary=3d6b6a416f9b5
Content-Length: 282

--3d6b6a416f9b5
Content-Type: text/html
Content-Range: bytes 0-50/1270

<!doctype html>
<html lang="en-US">
<head>
    <title>Example Do
--3d6b6a416f9b5
Content-Type: text/html
Content-Range: bytes 100-150/1270

eta http-equiv="Content-type" content="text/html; c
--3d6b6a416f9b5--

Conditional range requests

When resuming to request more parts of a resource, you need to guarantee that the stored resource has not been modified since the last fragment has been received.

The {{HTTPHeader("If-Range")}}  HTTP request header makes a range request conditional: if the condition is fulfilled, the range request will be issued and the server sends back a {{HTTPStatus("206")}}  Partial Content answer with the appropriate body. If the condition is not fulfilled, the full resource is sent back, with a {{HTTPStatus("200")}}  OK status. This header can be used either with a {{HTTPHeader("Last-Modified")}}  validator, or with an {{HTTPHeader("ETag")}} , but not with both.

If-Range: Wed, 21 Oct 2015 07:28:00 GMT

Partial request responses

There are three relevant statuses, when working with range requests:

Comparison to chunked Transfer-Encoding

The {{HTTPHeader("Transfer-Encoding")}}  header allows chunked encoding, which is useful when larger amounts of data are sent to the client and the total size of the response is not known until the request has been fully processed. The server sends data to the client straight away without buffering the response or determining the exact length, which leads to improved latency. Range requests and chunking are compatible and can be used with or without each other.

See also

In this article

View on MDN