Get the debt summary

curl -X GET "https://api.403fin.io/v1/debt/summary" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "X-API-Key: YOUR_API_KEY"

import requests
import json

url = "https://api.403fin.io/v1/debt/summary"
headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN",
  "X-API-Key": "YOUR_API_KEY"
}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch("https://api.403fin.io/v1/debt/summary", {
  method: "GET",
  headers: {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN",
  "X-API-Key": "YOUR_API_KEY"
}
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
)

func main() {

    req, err := http.NewRequest("GET", "https://api.403fin.io/v1/debt/summary", nil)
    if err != nil {
        panic(err)
    }

    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
    req.Header.Set("X-API-Key", "YOUR_API_KEY")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    fmt.Println("Response Status:", resp.Status)
}

require 'net/http'
require 'json'

uri = URI('https://api.403fin.io/v1/debt/summary')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request['X-API-Key'] = 'YOUR_API_KEY'

response = http.request(request)
puts response.body

{
  "data": {
    "summaries": [
      {
        "currency": "example_string",
        "total_debt": "example_string",
        "debt_count": 10,
        "total_ytd_interest_paid": "example_string",
        "ytd_interest_debt_count": 10,
        "estimated_monthly_interest": "example_string",
        "estimated_interest_debt_count": 10
      }
    ],
    "total_debt_count": 10
  },
  "pagination": {
    "next_cursor": "example_string",
    "has_more": true
  },
  "redacted_fields": [
    "example_string"
  ],
  "filtered": true
}

GET

/v1/debt/summary

GET

Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token

Bearer Tokenstring

Required

An opaque ff_ credential (ff_ak_ / ff_at_) presented as a Bearer token.

API Key (header: X-API-Key)

X-API-Keystring

Required

An opaque ff_ credential presented in the X-API-Key header.

Request Preview

Response

Response will appear here after sending the request

Authentication

header

Authorizationstring

Required

Bearer token. An opaque ff_ credential (ff_ak_ / ff_at_) presented as a Bearer token.

header

X-API-Keystring

Required

API Key for authentication. An opaque ff_ credential presented in the X-API-Key header.

Responses

dataobject

Required

paginationstring

Cursor pagination state, present on list endpoints.

redacted_fieldsstring[]

Field ids stripped from the payload by connection scope.

filteredboolean

True when row or aggregate filtering is in effect for this response.

Was this page helpful?

{ "data": { "summaries": [ { "currency": "example_string", "total_debt": "example_string", "debt_count": 10, "total_ytd_interest_paid": "example_string", "ytd_interest_debt_count": 10, "estimated_monthly_interest": "example_string", "estimated_interest_debt_count": 10 } ], "total_debt_count": 10 }, "pagination": { "next_cursor": "example_string", "has_more": true }, "redacted_fields": [ "example_string" ], "filtered": true }