GET
Rentabilidade

Authorizations

Authorization
string
header
required

HTTP Basic com o token como usuário e o secret como senha: curl -u dpz_tk_…:dpz_sk_…. Crie a chave em https://despezzas.com/settings/api-keys.

Query Parameters

date
string

Data de referência (YYYY-MM-DD). Padrão: hoje.

Example:

"2026-09-01"

limit
integer

Máximo de posições listadas. Padrão: 20 (máx. 50).

Example:

10

Response

Sucesso.

Rendimento diário das posições importadas pelo Open Finance, a partir dos snapshots de saldo. Enquanto não há snapshots suficientes, available é false e reason explica.

available
boolean
required

Se o rendimento pôde ser calculado.

Example:

true

by_type
object[]
required

Rendimento por tipo de investimento.

last_7_days
object
required
month_to_date
object
required
positions
object[]
required

Maiores posições (limite via limit).

previous
object
required
reason
string
required

Motivo quando available é false (vazio quando disponível).

Example:

""

today
object
required
estimated_ready_date
string

Quando haverá dados suficientes (YYYY-MM-DD).

Example:

"2026-08-02"

first_snapshot_date
string

Primeiro snapshot (YYYY-MM-DD).

Example:

"2026-08-01"

latest_snapshot_date
string

Último snapshot (YYYY-MM-DD).

Example:

"2026-09-15"

snapshot_days
integer

Dias com snapshot.

Example:

46

total_balance_cents
integer

Patrimônio no último snapshot. Em centavos.

Example:

4850000