LiqiDevelopers

Começando

Faça sua primeira chamada à API da Liqi em menos de 5 minutos. A Public API não requer autenticação, então você pode começar a explorar os dados imediatamente.

Pré-requisitos

Para os endpoints públicos, você não precisa de nada além de um cliente HTTP. Para APIs autenticadas, você precisará de:

APIO que você precisa
Public APINada — acesso livre
Developer APIUma API Key (solicite via suporte)
TIDC v1Par de chaves RSA (2048-bit) e cadastro de chave pública
CaaSCredenciais apiKey + secretKey fornecidas no onboarding

Sua primeira chamada

Vamos listar as séries ativas na plataforma. Esse endpoint retorna dados públicos sobre os títulos tokenizados disponíveis.

cURL

Bash
curl -X GET "https://api.liqi.com.br/public/tranches?status=ACTIVE" \
  -H "Accept: application/json"

Node.js

TypeScript
const response = await fetch(
  "https://api.liqi.com.br/public/tranches?status=ACTIVE",
  {
    headers: { "Accept": "application/json" },
  }
);

const data = await response.json();
console.log(`Total de séries ativas: ${data.count}`);

for (const tranche of data.items) {
  console.log(`${tranche.ticker} — ${tranche.name} — PU: R$ ${tranche.unitPrice}`);
}

Python

Python
import requests

response = requests.get(
    "https://api.liqi.com.br/public/tranches",
    params={"status": "ACTIVE"},
    headers={"Accept": "application/json"},
)

data = response.json()
print(f"Total de séries ativas: {data['count']}")

for tranche in data["items"]:
    print(f"{tranche['ticker']} — {tranche['name']} — PU: R$ {tranche['unitPrice']}")

Entendendo a resposta

A API retorna JSON com a seguinte estrutura padrão para listagens:

JSON
{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "ticker": "ROB1SR06",
      "name": "Robcap I - Série 06",
      "status": "ACTIVE",
      "className": "SENIOR",
      "unitPrice": "102.45000000",
      "tokenQuantity": "20000",
      "patrimonyTicker": "ROB1",
      "remunerationStartDate": "2025-01-01",
      "remunerationPercentagePerYear": "18.57"
    }
  ],
  "count": 15,
  "nextToken": "eyJpZCI6IjU1MGU4..."
}

Campos principais

CampoTipoDescrição
itemsarrayLista de objetos retornados
countnumberTotal de registros que correspondem ao filtro
nextTokenstring?Token para a próxima página (se houver mais resultados)

Campos da série

CampoTipoDescrição
tickerstringIdentificador único da série (ex: ROB1SR06)
statusstringStatus atual: DRAFT, ACTIVE, FUNDRAISING, CLOSED
classNamestringClasse de risco: SENIOR, MEZZANINE, JUNIOR, UNIQUE
unitPricestringPreço unitário atual do token (PU sujo), com 8 casas decimais
remunerationPercentagePerYearstringTaxa de remuneração anual (ex: 18.57 = 18.57% a.a.)

Filtrando resultados

A Public API suporta query parameters para filtrar os resultados:

Bash
# Filtrar por status
curl "https://api.liqi.com.br/public/tranches?status=FUNDRAISING"

# Filtrar por patrimônio
curl "https://api.liqi.com.br/public/tranches?patrimonyTicker=ROB1"

# Combinar filtros com paginação
curl "https://api.liqi.com.br/public/tranches?status=ACTIVE&limit=5"

Buscar detalhes de uma série

Para obter informações detalhadas de uma série específica, use o ticker:

Bash
curl "https://api.liqi.com.br/public/tranches/ROB1SR06/details"

Resposta:

JSON
{
  "ticker": "ROB1SR06",
  "name": "Robcap I - Série 06",
  "status": "ACTIVE",
  "className": "SENIOR",
  "unitPrice": "102.45000000",
  "nominalValue": "100.00000000",
  "interestJ": "2.45000000",
  "tokenQuantity": "20000",
  "totalValue": "500000.00",
  "investedAmount": "442112.42",
  "remunerationStartDate": "2025-01-01",
  "remunerationPercentagePerYear": "18.57",
  "dayCountBasis": "CIVIL",
  "patrimony": {
    "ticker": "ROB1",
    "name": "Robcap I"
  }
}

Cronograma de pagamentos

Cada série possui um cronograma de pagamentos público:

Bash
curl "https://api.liqi.com.br/public/tranches/ROB1SR06/payment-schedule"
JSON
{
  "items": [
    {
      "installmentNumber": 1,
      "dueDate": "2025-02-01",
      "status": "PAID",
      "interestPercentage": "100.00",
      "principalPercentage": "0.00",
      "interestValue": "3095.00",
      "principalValue": "0.00",
      "totalValue": "3095.00"
    }
  ],
  "count": 12
}

Próximos passos

Agora que você fez sua primeira chamada, explore os próximos tópicos: