Quickstart 5 min
Sua primeira chamada à API
Neste guia, você vai fazer sua primeira chamada à API da Liqi em menos de 5 minutos. Vamos usar a Public API, que não requer autenticação — basta um cliente HTTP.
Pré-requisitos
- Um terminal com
curlinstalado (macOS/Linux têm por padrão) - Ou qualquer cliente HTTP (Postman, Insomnia, httpie)
- Conexão com a internet
Dica
A Public API não requer cadastro nem API Key. Você pode começar agora mesmo.
1Listar séries ativas
Vamos começar listando as séries (tranches) atualmente ativas na plataforma. Cada série representa um título digital tokenizado com cronograma de pagamentos.
cURL
curl -s "https://api.liqi.com.br/public/tranches?status=ACTIVE&limit=3" \ -H "Accept: application/json" | python3 -m json.tool
A resposta retorna um array de séries com informações como ticker, nome, status e preço unitário:
Resposta
{
"items": [
{
"ticker": "ROB1SR06",
"name": "Robcap I - Serie 06",
"status": "ACTIVE",
"className": "SENIOR",
"unitPrice": "102.45000000",
"remunerationPercentagePerYear": "18.57"
}
],
"count": 15,
"page": 1,
"limit": 3
}2Buscar detalhes de uma série
Use o ticker de uma série para buscar informações detalhadas, incluindo dados do patrimônio vinculado e valores de investimento.
cURL
curl -s "https://api.liqi.com.br/public/tranches/ROB1SR06/details" \ -H "Accept: application/json" | python3 -m json.tool
Resposta
{
"ticker": "ROB1SR06",
"name": "Robcap I - Serie 06",
"status": "ACTIVE",
"className": "SENIOR",
"unitPrice": "102.45000000",
"nominalValue": "100.00000000",
"interestJ": "2.45000000",
"tokenQuantity": "20000",
"totalValue": "500000.00",
"investedAmount": "442112.42",
"remunerationPercentagePerYear": "18.57",
"dayCountBasis": "CIVIL",
"patrimony": {
"ticker": "ROB1",
"name": "Robcap I"
}
}| Campo | Descrição |
|---|---|
| unitPrice | PU sujo — preço atual do token com juros |
| nominalValue | PU limpo — preço sem juros acumulados |
| interestJ | Juros acumulados por token |
3Consultar cronograma de pagamentos
Cada série possui um cronograma público de pagamentos de juros e amortização:
cURL
curl -s "https://api.liqi.com.br/public/tranches/ROB1SR06/payment-schedule" \ -H "Accept: application/json" | python3 -m json.tool
Resposta (parcial)
{
"items": [
{
"installmentNumber": 1,
"dueDate": "2025-02-01",
"status": "PAID",
"interestValue": "3095.00",
"principalValue": "0.00",
"totalValue": "3095.00"
},
{
"installmentNumber": 2,
"dueDate": "2025-03-01",
"status": "PAID",
"interestValue": "3095.00",
"principalValue": "0.00",
"totalValue": "3095.00"
}
],
"count": 12
}4Integrar no seu código
Agora que você entende os endpoints básicos, veja como integrar no seu código:
Node.js / TypeScript
const BASE_URL = "https://api.liqi.com.br";
// 1. Listar series ativas
const tranches = await fetch(`${BASE_URL}/public/tranches?status=ACTIVE`)
.then((r) => r.json());
console.log(`${tranches.count} series ativas encontradas`);
// 2. Buscar detalhes da primeira serie
const ticker = tranches.items[0].ticker;
const details = await fetch(`${BASE_URL}/public/tranches/${ticker}/details`)
.then((r) => r.json());
console.log(`${details.name} — PU: R$ ${details.unitPrice}`);
// 3. Buscar cronograma de pagamentos
const schedule = await fetch(`${BASE_URL}/public/tranches/${ticker}/payment-schedule`)
.then((r) => r.json());
console.log(`${schedule.count} parcelas no cronograma`);
for (const entry of schedule.items) {
console.log(` Parcela ${entry.installmentNumber}: ${entry.status} — R$ ${entry.totalValue}`);
}Python
import requests
BASE_URL = "https://api.liqi.com.br"
# 1. Listar series ativas
tranches = requests.get(f"{BASE_URL}/public/tranches", params={"status": "ACTIVE"}).json()
print(f"{tranches['count']} series ativas encontradas")
# 2. Buscar detalhes da primeira serie
ticker = tranches["items"][0]["ticker"]
details = requests.get(f"{BASE_URL}/public/tranches/{ticker}/details").json()
print(f"{details['name']} — PU: R$ {details['unitPrice']}")
# 3. Buscar cronograma de pagamentos
schedule = requests.get(f"{BASE_URL}/public/tranches/{ticker}/payment-schedule").json()
print(f"{schedule['count']} parcelas no cronograma")
for entry in schedule["items"]:
print(f" Parcela {entry['installmentNumber']}: {entry['status']} — R$ {entry['totalValue']}")Próximos passos
Agora que você fez suas primeiras chamadas, explore mais: