prometheus/docs/querying/remote_read_api.md

---
title: Remote Read API
sort_rank: 7
---

# Remote Read API

> This is not currently considered part of the stable API and is subject to change even between non-major version releases of Prometheus.

This API provides data read functionality from Prometheus. This interface expects [snappy](https://github.com/google/snappy) compression.
The API definition is located [here](https://github.com/prometheus/prometheus/blob/master/prompb/remote.proto).

Request are made to the following endpoint.
```
/api/v1/read
```

### Samples

This returns a message that includes a list of raw samples.

### Streamed Chunks

These streamed chunks utilize an XOR algorithm inspired by the [Gorilla](http://www.vldb.org/pvldb/vol8/p1816-teller.pdf)
compression to encode the chunks. However, it provides resolution to the millisecond instead of to the second.
documentation: Add Reference to the remote read API - For now this is relatively simplistic, but at least acknowledges some of the basics, and points out some parts that might not be obvious at first. Relates to #7192 Signed-off-by: Harold Dost <h.dost@criteo.com> 2020-05-18 08:16:02 +00:00			`---`
			`title: Remote Read API`
			`sort_rank: 7`
			`---`

			`# Remote Read API`

removed formateoverview section (#13994) docs: Remove outdated information about remote-read API --------- Signed-off-by: kushagra Shukla <kushalshukla110@gmail.com> Signed-off-by: Kushal shukla <85934954+kushalShukla-web@users.noreply.github.com> Signed-off-by: Arthur Silva Sens <arthur.sens@coralogix.com> Co-authored-by: Arthur Silva Sens <arthur.sens@coralogix.com> 2024-05-03 12:42:39 +00:00			`> This is not currently considered part of the stable API and is subject to change even between non-major version releases of Prometheus.`
documentation: Add Reference to the remote read API - For now this is relatively simplistic, but at least acknowledges some of the basics, and points out some parts that might not be obvious at first. Relates to #7192 Signed-off-by: Harold Dost <h.dost@criteo.com> 2020-05-18 08:16:02 +00:00
			`This API provides data read functionality from Prometheus. This interface expects [snappy](https://github.com/google/snappy) compression.`
			`The API definition is located [here](https://github.com/prometheus/prometheus/blob/master/prompb/remote.proto).`

			`Request are made to the following endpoint.`
			```
			`/api/v1/read`
			```

			`### Samples`

			`This returns a message that includes a list of raw samples.`

			`### Streamed Chunks`

			`These streamed chunks utilize an XOR algorithm inspired by the [Gorilla](http://www.vldb.org/pvldb/vol8/p1816-teller.pdf)`
			`compression to encode the chunks. However, it provides resolution to the millisecond instead of to the second.`