Extrato da chave
curl --request GET \
--url https://{instancia}/api/v1/consultas \
--header 'Authorization: Bearer <token>'import requests
url = "https://{instancia}/api/v1/consultas"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{instancia}/api/v1/consultas', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{instancia}/api/v1/consultas",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{instancia}/api/v1/consultas"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{instancia}/api/v1/consultas")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instancia}/api/v1/consultas")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"uso": {
"hoje": 1,
"mes": 1,
"total": 1
},
"consultas": [
{
"id": "<string>",
"produto": "<string>",
"documento": "<string>",
"status": "SUCCESS",
"cobrada": true,
"duracaoMs": 123,
"erro": "<string>",
"consultadoEm": "2023-11-07T05:31:56Z"
}
]
}{
"erro": {
"codigo": "nao_encontrado",
"mensagem": "Documento não localizado.",
"detalhe": {}
}
}Consultar documentos
Extrato da chave
Devolve o consumo da chave e a lista do que ela consultou. Não gera cobrança.
O extrato é da chave, não da organização: uma chave de integração não enxerga o que a equipe consultou pela tela do app.
GET
/
api
/
v1
/
consultas
Extrato da chave
curl --request GET \
--url https://{instancia}/api/v1/consultas \
--header 'Authorization: Bearer <token>'import requests
url = "https://{instancia}/api/v1/consultas"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{instancia}/api/v1/consultas', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{instancia}/api/v1/consultas",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{instancia}/api/v1/consultas"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{instancia}/api/v1/consultas")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instancia}/api/v1/consultas")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"uso": {
"hoje": 1,
"mes": 1,
"total": 1
},
"consultas": [
{
"id": "<string>",
"produto": "<string>",
"documento": "<string>",
"status": "SUCCESS",
"cobrada": true,
"duracaoMs": 123,
"erro": "<string>",
"consultadoEm": "2023-11-07T05:31:56Z"
}
]
}{
"erro": {
"codigo": "nao_encontrado",
"mensagem": "Documento não localizado.",
"detalhe": {}
}
}Consumo da chave e lista do que ela consultou. Serve para conferir gasto antes de bater no
teto e para reconciliar cobrança do seu lado.
O extrato é da chave, não da organização: uma chave de integração não enxerga o que a
equipe consultou pela tela do app, o que é deliberado.
O bloco
Não gera cobrança
Lê só o histórico.
uso conta apenas consultas cobradas. Consulta servida do histórico não entra na
conta, porque também não custou nada.
Resposta:
{
"uso": { "hoje": 1, "mes": 1, "total": 1 },
"consultas": [
{
"id": "cmtsr515m1uxzjn04ta469e3q",
"produto": "search-pj",
"documento": "11222333000181",
"status": "SUCCESS",
"cobrada": true,
"duracaoMs": 609,
"erro": null,
"consultadoEm": "2026-09-08T14:15:35.194Z"
}
]
}
Authorizations
Chave de API criada em Configurações, Integrações, Chaves de API. Começa com sk_live_ e aparece uma vez só. O cabeçalho X-API-Key também é aceito, com o mesmo valor.
Query Parameters
Quantas consultas trazer. O máximo é 100.
Required range:
x <= 100Filtra por id de produto.
Filtra por documento. Pontuação é ignorada.