Patrimônios
Consulta de patrimônios separados cadastrados na plataforma. Cada patrimônio agrupa uma ou mais séries (tranches) e possui contas bancárias vinculadas para movimentação financeira.
Base URL
Todos os endpoints da Public API usam a base URL https://api.liqi.com.br. Nenhuma autenticação é necessária.
Listar Patrimônios
/public/patrimoniesRetorna uma lista paginada de patrimônios públicos.
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
page | integer | Optional | Número da página para paginação.(default: 1) |
limit | integer | Optional | Quantidade de registros por página.(default: 10) |
status | string | Optional | Filtrar por status do patrimônio: ACTIVE, INACTIVE. |
search | string | Optional | Busca textual por nome ou CNPJ do patrimônio. |
Resposta
Retorna um objeto paginado com um array data de patrimônios. Cada patrimônio inclui o total de séries vinculadas e o valor total da operação.
Detalhes do Patrimônio
/public/patrimonies/:idRetorna os dados completos de um patrimônio específico.
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | uuid | Required | ID único do patrimônio. |
Resposta
Retorna os dados completos do patrimônio, incluindo:
agent— empresa originadora/securitizadora vinculadabankAccounts— contas bancárias do patrimôniototalTranches— número de sériesinvestedAmount— valor total captado em todas as séries
Séries do Patrimônio
/public/patrimonies/:id/tranchesRetorna a lista de séries (tranches) vinculadas a um patrimônio.
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | uuid | Required | ID único do patrimônio. |
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
page | integer | Optional | Número da página.(default: 1) |
limit | integer | Optional | Registros por página.(default: 10) |
status | string | Optional | Filtrar por status: ACTIVE, CLOSED, FUNDRAISING. |
class | string | Optional | Filtrar por classe: SENIOR, MEZZANINE, JUNIOR, SINGLE. |
Resposta
Retorna um objeto paginado com as séries do patrimônio. Cada série inclui ticker, classe, tipo de remuneração, valor investido e data de vencimento.
Relação Patrimônio-Série
Um patrimônio pode ter múltiplas séries de classes diferentes (Sênior, Mezanino, Júnior). A subordinação define a prioridade de pagamento entre elas.
Estatísticas do Patrimônio
/public/patrimonies/:id/statsRetorna estatísticas agregadas de um patrimônio, incluindo valores pagos e próximos vencimentos.
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | uuid | Required | ID único do patrimônio. |
Campos da Resposta
| Name | Type | Required | Description |
|---|---|---|---|
totalTranches | integer | Required | Número total de séries no patrimônio. |
activeTranches | integer | Required | Séries atualmente ativas. |
closedTranches | integer | Required | Séries já encerradas. |
totalValue | decimal | Required | Valor total ofertado em R$ (soma de todas as séries). |
totalInvested | decimal | Required | Valor total efetivamente captado em R$. |
totalPaidInterest | decimal | Required | Total de juros já pagos em R$ (todas as séries). |
totalPaidPrincipal | decimal | Required | Total de principal já amortizado em R$ (todas as séries). |
nextPaymentDate | date | Required | Data do próximo pagamento entre todas as séries (YYYY-MM-DD). |
nextPaymentAmount | decimal | Required | Valor estimado do próximo pagamento em R$. |