Consultar restrições da entidade
curl --request GET \
--url https://api.base39.com.br/v2/entities/{id}/restrictions \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.base39.com.br/v2/entities/{id}/restrictions"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.base39.com.br/v2/entities/{id}/restrictions', 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://api.base39.com.br/v2/entities/{id}/restrictions",
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://api.base39.com.br/v2/entities/{id}/restrictions"
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://api.base39.com.br/v2/entities/{id}/restrictions")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.base39.com.br/v2/entities/{id}/restrictions")
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{
"object": "list",
"results": [
{
"datasets": [
{
"slug": "<string>",
"recordCount": 123,
"hasData": true,
"kpis": [
{
"key": "<string>",
"label": "<string>",
"amount": 123,
"count": 123
}
],
"name": "<string>",
"queryId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"status": "<string>",
"cacheStatus": "<string>",
"cost": 123,
"description": "<string>",
"score": 123,
"riskLabel": "<string>"
}
],
"summaryRows": [
{
"key": "<string>",
"label": "<string>",
"cells": [
{
"datasetSlug": "<string>",
"applies": true,
"confirmed": true,
"count": 123,
"amount": 123,
"description": "<string>"
}
]
}
],
"recordSections": [
{
"key": "<string>",
"label": "<string>",
"records": [
{
"key": "<string>",
"category": "<string>",
"sources": [
{
"slug": "<string>",
"label": "<string>",
"queryId": "<string>"
}
],
"sourceRecords": [
{
"key": "<string>",
"category": "<string>",
"source": {
"slug": "<string>",
"label": "<string>",
"queryId": "<string>"
},
"date": "<string>",
"dueDate": "<string>",
"value": 123,
"creditor": "<string>",
"institution": "<string>",
"contract": "<string>",
"modality": "<string>",
"document": "<string>",
"notary": "<string>",
"city": "<string>",
"state": "<string>",
"status": "<string>",
"type": "<string>",
"origin": "<string>",
"maturity": "<string>"
}
],
"date": "<string>",
"dueDate": "<string>",
"value": 123,
"creditor": "<string>",
"institution": "<string>",
"contract": "<string>",
"modality": "<string>",
"document": "<string>",
"notary": "<string>",
"city": "<string>",
"state": "<string>",
"status": "<string>",
"type": "<string>",
"origin": "<string>",
"maturity": "<string>"
}
]
}
],
"protests": [
{
"key": "<string>",
"category": "<string>",
"sources": [
{
"slug": "<string>",
"label": "<string>",
"queryId": "<string>"
}
],
"sourceRecords": [
{
"key": "<string>",
"category": "<string>",
"source": {
"slug": "<string>",
"label": "<string>",
"queryId": "<string>"
},
"date": "<string>",
"dueDate": "<string>",
"value": 123,
"creditor": "<string>",
"institution": "<string>",
"contract": "<string>",
"modality": "<string>",
"document": "<string>",
"notary": "<string>",
"city": "<string>",
"state": "<string>",
"status": "<string>",
"type": "<string>",
"origin": "<string>",
"maturity": "<string>"
}
],
"date": "<string>",
"dueDate": "<string>",
"value": 123,
"creditor": "<string>",
"institution": "<string>",
"contract": "<string>",
"modality": "<string>",
"document": "<string>",
"notary": "<string>",
"city": "<string>",
"state": "<string>",
"status": "<string>",
"type": "<string>",
"origin": "<string>",
"maturity": "<string>"
}
]
}
],
"has_more": true,
"metadata": {
"status": "NOT_QUERIED",
"provenance": {
"datasets": [
{
"datasetSlug": "<string>",
"requirement": "required",
"visible": true,
"onRefresh": true,
"sourcePriority": 123,
"status": "NOT_QUERIED",
"queryId": "<string>",
"observedAt": "<string>",
"recordedAt": "<string>",
"errorCode": "upstream_error"
}
]
},
"summary": "<string>"
},
"next_cursor": "<string>",
"type": "<string>"
}Restrições
Consultar restrições da entidade
Retorna o resumo consolidado de restrições, com status e proveniência das fontes.
GET
/
v2
/
entities
/
{id}
/
restrictions
Consultar restrições da entidade
curl --request GET \
--url https://api.base39.com.br/v2/entities/{id}/restrictions \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.base39.com.br/v2/entities/{id}/restrictions"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.base39.com.br/v2/entities/{id}/restrictions', 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://api.base39.com.br/v2/entities/{id}/restrictions",
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://api.base39.com.br/v2/entities/{id}/restrictions"
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://api.base39.com.br/v2/entities/{id}/restrictions")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.base39.com.br/v2/entities/{id}/restrictions")
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{
"object": "list",
"results": [
{
"datasets": [
{
"slug": "<string>",
"recordCount": 123,
"hasData": true,
"kpis": [
{
"key": "<string>",
"label": "<string>",
"amount": 123,
"count": 123
}
],
"name": "<string>",
"queryId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"status": "<string>",
"cacheStatus": "<string>",
"cost": 123,
"description": "<string>",
"score": 123,
"riskLabel": "<string>"
}
],
"summaryRows": [
{
"key": "<string>",
"label": "<string>",
"cells": [
{
"datasetSlug": "<string>",
"applies": true,
"confirmed": true,
"count": 123,
"amount": 123,
"description": "<string>"
}
]
}
],
"recordSections": [
{
"key": "<string>",
"label": "<string>",
"records": [
{
"key": "<string>",
"category": "<string>",
"sources": [
{
"slug": "<string>",
"label": "<string>",
"queryId": "<string>"
}
],
"sourceRecords": [
{
"key": "<string>",
"category": "<string>",
"source": {
"slug": "<string>",
"label": "<string>",
"queryId": "<string>"
},
"date": "<string>",
"dueDate": "<string>",
"value": 123,
"creditor": "<string>",
"institution": "<string>",
"contract": "<string>",
"modality": "<string>",
"document": "<string>",
"notary": "<string>",
"city": "<string>",
"state": "<string>",
"status": "<string>",
"type": "<string>",
"origin": "<string>",
"maturity": "<string>"
}
],
"date": "<string>",
"dueDate": "<string>",
"value": 123,
"creditor": "<string>",
"institution": "<string>",
"contract": "<string>",
"modality": "<string>",
"document": "<string>",
"notary": "<string>",
"city": "<string>",
"state": "<string>",
"status": "<string>",
"type": "<string>",
"origin": "<string>",
"maturity": "<string>"
}
]
}
],
"protests": [
{
"key": "<string>",
"category": "<string>",
"sources": [
{
"slug": "<string>",
"label": "<string>",
"queryId": "<string>"
}
],
"sourceRecords": [
{
"key": "<string>",
"category": "<string>",
"source": {
"slug": "<string>",
"label": "<string>",
"queryId": "<string>"
},
"date": "<string>",
"dueDate": "<string>",
"value": 123,
"creditor": "<string>",
"institution": "<string>",
"contract": "<string>",
"modality": "<string>",
"document": "<string>",
"notary": "<string>",
"city": "<string>",
"state": "<string>",
"status": "<string>",
"type": "<string>",
"origin": "<string>",
"maturity": "<string>"
}
],
"date": "<string>",
"dueDate": "<string>",
"value": 123,
"creditor": "<string>",
"institution": "<string>",
"contract": "<string>",
"modality": "<string>",
"document": "<string>",
"notary": "<string>",
"city": "<string>",
"state": "<string>",
"status": "<string>",
"type": "<string>",
"origin": "<string>",
"maturity": "<string>"
}
]
}
],
"has_more": true,
"metadata": {
"status": "NOT_QUERIED",
"provenance": {
"datasets": [
{
"datasetSlug": "<string>",
"requirement": "required",
"visible": true,
"onRefresh": true,
"sourcePriority": 123,
"status": "NOT_QUERIED",
"queryId": "<string>",
"observedAt": "<string>",
"recordedAt": "<string>",
"errorCode": "upstream_error"
}
]
},
"summary": "<string>"
},
"next_cursor": "<string>",
"type": "<string>"
}Autorizações
OAuth2 Authorization Code flow
Parâmetros de caminho
CPF, CNPJ ou identificador da empresa (cmp_*).
Parâmetros de consulta
Data de referência (YYYY-MM-DD)
Campos opcionais separados por vírgula: "summary.short", "summary.long" e "summary.mdx". Sem summary.*, o campo metadata.summary é omitido.
Resposta
200 - application/json
Consulta concluída. Verifique o status e a proveniência dos dados quando presentes.
Identificador do tipo do objeto
Lista de resultados da página atual
Show child attributes
Show child attributes
Indica se há mais resultados após esta página
Status e proveniência do domínio. Uma lista vazia deve ser interpretada junto com esses metadados.
Show child attributes
Show child attributes
Cursor da próxima página; nulo quando não há mais resultados.
Tipo dos resultados
⌘I