Developer APIAPI Key

Monitor API

API consolidada para monitoramento de tokens tokenizados pela Liqi. Fornece dados completos de captação, cronograma de pagamentos, investidores e status em uma única chamada — reduzindo de milhares de requisições para poucas centenas por dia.

Autenticação Obrigatória

A Monitor API requer autenticação via API Key. Inclua o header X-API-Key em todas as requisições. Para obter uma API Key, entre em contato com o time de integração da Liqi.

Cache e Performance

As respostas são cacheadas por 4 minutos no servidor. Para polling, recomendamos intervalo de 5 minutos. O campo metadata.lastFullUpdate indica quando os dados foram atualizados pela última vez.

Listar Tokens

GET/api/v1/monitor/tokens

Retorna a lista de todos os tokens com dados consolidados de captação, investidores, cronograma de pagamentos e metadados.

Headers

Name	Type	Required	Description
`X-API-Key`	string	Required	Chave de API para autenticação.

Query Parameters

Name	Type	Required	Description
`status`	string	Optional	Filtrar por status: PUBLISHED (captando) ou CLOSED (encerrado).
`search`	string	Optional	Busca por ticker, nome do patrimônio ou nome do emissor.
`asset_type`	string	Optional	Filtrar por tipo de ativo: CRI, CRA, CR, DEBENTURE, etc.
`sort_by`	string	Optional	Campo de ordenação: ticker, status, issuer_name, fundraising_value, updated_at.
`sort_dir`	string	Optional	Direção da ordenação: asc ou desc.(default: `desc`)
`offset`	integer	Optional	Offset para paginação.(default: `0`)
`limit`	integer	Optional	Limite de itens por página (1-500).(default: `200`)
`updated_since`	string	Optional	Data ISO 8601 para sync incremental. Retorna apenas tokens atualizados após esta data.

Resposta

Retorna data.tokens com os tokens, data.pagination para controle de paginação, e data.metadata com contagens agregadas. Cada token inclui:

tokenSymbol — ticker da série (ex: DUX1SR01)
tokenName — nome completo do patrimônio
fundraisingStatus — PUBLISHED (captando) ou CLOSED
investedAmount / investedPercentage — valor e percentual captados
fundraisingUniqueInvestorsQuantity — investidores únicos
paymentSchedule — cronograma completo com parcelas
additionalData — classe da série, base de contagem, regulatório

Detalhe do Token

GET/api/v1/monitor/tokens/{symbol}

Retorna os dados completos de um token específico pelo seu ticker/símbolo.

Headers

Name	Type	Required	Description
`X-API-Key`	string	Required	Chave de API para autenticação.

Path Parameters

Name	Type	Required	Description
`symbol`	string	Required	Ticker do token (ex: DUX1SR01). Máximo 20 caracteres alfanuméricos.

Resposta

Mesmo formato da listagem, com data.tokens contendo 1 item (ou array vazio se o token não existir). Inclui cronograma completo de pagamentos.

Próximos Pagamentos

GET/api/v1/monitor/payments/upcoming

Retorna os próximos pagamentos de todos os tokens dentro de uma janela configurável.

Headers

Name	Type	Required	Description
`X-API-Key`	string	Required	Chave de API para autenticação.

Query Parameters

Name	Type	Required	Description
`days_ahead`	integer	Optional	Janela de dias para buscar pagamentos futuros (1-365).(default: `90`)
`token`	string	Optional	Filtrar por ticker específico (ex: DUX1SR01).
`issuer`	string	Optional	Filtrar por nome do emissor (busca parcial).
`offset`	integer	Optional	Offset para paginação.(default: `0`)
`limit`	integer	Optional	Limite de itens por página (1-500).(default: `200`)

Resposta

Retorna data.payments com os pagamentos pendentes, ordenados por data de vencimento:

tokenSymbol / tokenName — identificação do token
installment — parcela no formato "X/Y"
dueDate — data de vencimento (YYYY-MM-DD)
daysRemaining — dias restantes até o vencimento
interestPercentage / principalPercentage — percentuais de juros e amortização

Valores de Status

Status	Descrição
`PUBLISHED`	Token em captação ativa (status interno ACTIVE ou FUNDRAISING).
`CLOSED`	Captação encerrada. O token continua com cronograma de pagamentos ativo.

Tipos de Ativo

Tipo	Nome Completo
`CRI`	Certificado de Recebíveis Imobiliários
`CRA`	Certificado de Recebíveis do Agronegócio
`CR`	Certificado de Recebíveis
`DEBENTURE`	Debênture
`FIDC`	Fundo de Investimento em Direitos Creditórios

Tipos de Indicador

Indicador	Descrição	Exemplo
`PRE_FIXED`	Taxa fixa pré-definida ao ano	18.57% a.a.
`CDI`	Indexado ao CDI com spread	CDI + 3%
`USD`	Indexado ao dólar	USD + 5% a.a.

Rate Limiting

A Monitor API permite até 500 requisições por hora por API Key. Respostas incluem os headers:

X-RateLimit-Limit — limite total
X-RateLimit-Remaining — requisições restantes
Retry-After — segundos para esperar (quando 429)

Recomendação de Polling

Com cache de 4 minutos no servidor, recomendamos polling a cada 5 minutos. Isso resulta em ~288 requisições/dia por endpoint — bem dentro do limite de 500/hora.

Listar Tokens

cURL

curl -X GET "https://api.liqi.com.br/api/v1/monitor/tokens?limit=5" \
  -H "Accept: application/json" \
  -H "X-API-Key: your-api-key-here"

TypeScript

import axios from "axios";

const response = await axios.get(
  "https://api.liqi.com.br/api/v1/monitor/tokens",
  {
    headers: {
      "X-API-Key": process.env.MONITOR_API_KEY,
    },
    params: {
      status: "PUBLISHED",
      limit: 50,
    },
  }
);

const { tokens, pagination, metadata } = response.data.data;
console.log(`${pagination.total} tokens encontrados`);

for (const token of tokens) {
  console.log(
    `${token.tokenSymbol}: ${token.investedPercentage.toFixed(1)}% captado`
  );
}

200Lista de tokens com dados consolidados

{
  "success": true,
  "data": {
    "tokens": [
      {
        "tokenSymbol": "DUX1SR01",
        "tokenName": "DUX Capital Senior 01",
        "slug": "dux-capital",
        "issuerName": "DUX Capital",
        "issuerLogoUrl": "https://assets.liqi.com.br/logos/dux-capital.png",
        "fundraisingStatus": "PUBLISHED",
        "assetType": "CRI",
        "fundraisingValue": 5000000,
        "fundraisingRemainingValue": 1250000,
        "investedAmount": 3750000,
        "investedPercentage": 75,
        "fundraisingUniqueInvestorsQuantity": 128,
        "tokenQuantity": 50000,
        "unitPrice": 100,
        "preFixedRentabilityPercentage": 18.57,
        "indicatorType": "PRE_FIXED",
        "indicatorValue": 18.57,
        "fundraisingPublishedAt": "2025-06-15T12:00:00.000Z",
        "fundraisingStartDate": "2025-07-01T00:00:00.000Z",
        "interestStartDate": "2025-07-01T00:00:00.000Z",
        "lastPayScheduleDueDate": "2026-06-01T00:00:00.000Z",
        "paymentSchedule": [
          {
            "installment": "1/12",
            "dueDate": "2025-08-01",
            "interestPercentage": "100.00%",
            "principalPercentage": "0.00%",
            "status": "PAID"
          },
          {
            "installment": "2/12",
            "dueDate": "2025-09-01",
            "interestPercentage": "100.00%",
            "principalPercentage": "0.00%",
            "status": "PENDING"
          }
        ],
        "additionalData": {
          "trancheClass": "SENIOR",
          "countingDays": "CIVIL",
          "regulatory": null
        },
        "updatedAt": "2026-03-10T14:30:00.000Z"
      }
    ],
    "pagination": {
      "total": 45,
      "offset": 0,
      "limit": 5,
      "hasMore": true
    },
    "metadata": {
      "statusCounts": {
        "PUBLISHED": 32,
        "CLOSED": 13
      },
      "assetTypeCounts": {
        "CRI": 15,
        "CRA": 8,
        "CR": 12,
        "DEBENTURE": 10
      },
      "lastFullUpdate": "2026-03-10T14:30:00.000Z"
    }
  }
}

Detalhe do Token

cURL

curl -X GET "https://api.liqi.com.br/api/v1/monitor/tokens/DUX1SR01" \
  -H "Accept: application/json" \
  -H "X-API-Key: your-api-key-here"

200Token individual com cronograma completo

{
  "success": true,
  "data": {
    "tokens": [
      {
        "tokenSymbol": "DUX1SR01",
        "tokenName": "DUX Capital Senior 01",
        "slug": "dux-capital",
        "issuerName": "DUX Capital",
        "fundraisingStatus": "PUBLISHED",
        "assetType": "CRI",
        "fundraisingValue": 5000000,
        "investedAmount": 3750000,
        "investedPercentage": 75,
        "fundraisingUniqueInvestorsQuantity": 128,
        "paymentSchedule": [
          "... (cronograma completo)"
        ],
        "additionalData": {
          "trancheClass": "SENIOR",
          "countingDays": "CIVIL",
          "regulatory": null
        }
      }
    ],
    "pagination": {
      "total": 1,
      "offset": 0,
      "limit": 1,
      "hasMore": false
    },
    "metadata": {
      "statusCounts": {
        "PUBLISHED": 1
      },
      "assetTypeCounts": {
        "CRI": 1
      },
      "lastFullUpdate": "2026-03-10T14:30:00.000Z"
    }
  }
}

Próximos Pagamentos

cURL

curl -X GET "https://api.liqi.com.br/api/v1/monitor/payments/upcoming?days_ahead=30" \
  -H "Accept: application/json" \
  -H "X-API-Key: your-api-key-here"

TypeScript

import axios from "axios";

const response = await axios.get(
  "https://api.liqi.com.br/api/v1/monitor/payments/upcoming",
  {
    headers: { "X-API-Key": process.env.MONITOR_API_KEY },
    params: { days_ahead: 30 },
  }
);

const { payments } = response.data.data;
for (const p of payments) {
  console.log(
    `${p.tokenSymbol} parcela ${p.installment} — vence em ${p.daysRemaining} dias (${p.dueDate})`
  );
}

200Pagamentos nos próximos 30 dias

{
  "success": true,
  "data": {
    "payments": [
      {
        "tokenSymbol": "DUX1SR01",
        "tokenName": "DUX Capital Senior 01",
        "issuerName": "DUX Capital",
        "installment": "5/12",
        "dueDate": "2026-03-15",
        "interestPercentage": "100.00%",
        "principalPercentage": "0.00%",
        "daysRemaining": 5,
        "status": "PENDING"
      },
      {
        "tokenSymbol": "ROB1SR06",
        "tokenName": "Robocred Senior 06",
        "issuerName": "Robocred",
        "installment": "8/12",
        "dueDate": "2026-04-01",
        "interestPercentage": "100.00%",
        "principalPercentage": "8.33%",
        "daysRemaining": 22,
        "status": "PENDING"
      }
    ],
    "pagination": {
      "total": 12,
      "offset": 0,
      "limit": 200,
      "hasMore": false
    }
  }
}

Erro: API Key Ausente

401Unauthorized

{
  "statusCode": 401,
  "message": "Missing API key. Include X-API-Key header.",
  "error": "Unauthorized"
}

Token Não Encontrado

200Retorna lista vazia quando o token não existe

{
  "success": true,
  "data": {
    "tokens": [],
    "pagination": {
      "total": 0,
      "offset": 0,
      "limit": 1,
      "hasMore": false
    },
    "metadata": {
      "statusCounts": {},
      "assetTypeCounts": {},
      "lastFullUpdate": "2026-03-10T14:30:00.000Z"
    }
  }
}