Fintatica
Home
WebsiteContato
Home
WebsiteContato
  1. Getting started
  • Getting started
    • Introduction
    • Quick start
    • SDKs & Libraries
    • Authentication & Limits
    • Error Codes
    • Common Params
  • Investment Funds
    • Retrive Portifolio
      GET
    • FOF Portifolio Look-Through
      GET
  • Others
    • Flight Fares
      GET
  • FAQ
    • FAQ
  1. Getting started

SDKs & Libraries

Use our SDKs to go from “works in curl” to “production-grade” faster. They wrap the REST API, add retries, pagination helpers, and typed responses—so you can focus on your logic, not glue code.
Status: SDKs are coming soon and will launch as GA (production-ready).
Docs location: Each SDK’s GitHub repo hosts the full developer docs.
Auth: Both SDKs use X-API-Key under the hood (or api_key query for GET if you really need it).
Base URL: https://api.fintatica.com.br/v1 (baked into the SDKs).

JavaScript / TypeScript SDK#

Repo (placeholder): https://github.com/fintatica/fintatica-js
Package (suggested): @fintatica/sdk
Runtime: Node.js LTS (ESM and CJS supported). No browser support.
License: MIT
Versioning: SemVer

Why use it#

First-class TypeScript types
Auto-retry with backoff on 429/5xx (+ jitter)
Pagination helpers (iterate pages safely)
Date helpers for YYYYMMDD
Error objects mirroring API shape
Convenience methods per endpoint (e.g., client.funds.list())

Install (placeholder)#

Quick start (ESM)#

import { Fintatica } from '@fintatica/sdk';

const client = new Fintatica({
  app_name: "My App Name",
  api_key: process.env.FT_API_KEY
});

const res = await client.funds.list({
  page: 0,
  page_size: 100,
  sort_by: 'updated_at',
  sort_order: 'desc',
});

console.log(res.items.length, 'funds');

Iterating pages (helper)#

for await (const fund of client.funds.iter({ page_size: 250 })) {
  // process fund
}

Error handling#

try {
  await client.funds.list({ page: -1 }); // invalid
} catch (err: any) {
  if (err?.isFintaticaError) {
    console.error(err.code, err.message, err.error_data);
    // err.status, err.requestId also available
  } else {
    throw err;
  }
}

Python SDK#

Repo (placeholder): https://github.com/fintatica/fintatica-py
Package (suggested): fintatica (PyPI)
Runtime: Python 3.10+ (aligned with widely supported LTS versions)
License: MIT
Versioning: SemVer

Why use it#

Pydantic models for typed responses
Auto-retry with backoff on 429/5xx (+ jitter)
Pagination helpers (generators)
Date helpers for YYYYMMDD
Error classes mirroring API shape
Convenience methods per endpoint (e.g., client.funds.list())

Install (placeholder)#

Quick start#

Iterating pages (generator)#

Error handling#


Feature Matrix#

CapabilityJS/TS SDKPython SDK
Node/Python LTS support✅✅
ESM + CJS (JS)✅—
Typed models (TS / Pydantic)✅✅
Auto-retry (429/5xx + jitter)✅✅
Pagination helpers (iter)✅✅
Date helpers (YYYYMMDD)✅✅
Error shape parity with API✅✅
Convenience endpoint methods✅✅
Built-in X-API-Key auth✅✅
Download helpers (format, etc.)✅✅
SDKs follow the same Common Params as the REST API (page zero-based, page_size, date / from+to, sort_by, sort_order, format, download).

Usage Notes (applies to both SDKs)#

Authentication: Provide your key via FT_API_KEY env var or pass apiKey/api_key to the client. SDKs always send X-API-Key; for GET requests they can fall back to api_key query if needed. If both are present, header wins.
Rate limits: Defaults are 100 req/min per key. SDKs respect Retry-After and implement exponential backoff with jitter.
Pagination: Prefer iter helpers for large syncs; they handle page increments and termination (stop when a page returns fewer than requested).
Dates: Use YYYYMMDD strictly for date, from, to params.
Errors: Exceptions include code, message, error_data, status, and request_id for support.

Repositories & Docs (placeholders)#

JS/TS SDK: https://github.com/fintatica/fintatica-js — Readme-first docs in repo
Python SDK: https://github.com/fintatica/fintatica-py — Readme-first docs in repo
Examples/starter templates: https://github.com/fintatica/examples — (placeholder)

Coming Soon#

We plan to extend official clients and tooling:
Go — idiomatic client with context/timeouts, pagination iterators
R — tidy data frames, readr-friendly CSV helpers
Rust — async client, typed models (serde)
Kotlin — JVM client, coroutines, data classes
OpenAPI spec — for codegen and Postman collections
Want to influence priorities? Email contato@fintatica.com.br with your stack and use case.

Versioning, License & Contributing#

SemVer: We avoid breaking changes within a major SDK version. APIs tracked: /v1.
License: MIT
Contributing: We welcome issues & PRs (bug reports, docs tweaks, small features). See each repo’s CONTRIBUTING.md.

Why choose the SDKs over raw HTTP?#

Less boilerplate: retries, pagination, and validation baked in.
Fewer mistakes: consistent handling of YYYYMMDD, 0-based page, and page_size limits.
Safer: unified error objects and request IDs make support & observability easier.
Future-proof: when endpoints evolve, SDK methods update without rewriting your integration.
Next up: pick your language above, set FT_API_KEY, and ship your first query—see Quick Start for API basics and Common Params for knobs and dials.
Previous
Quick start
Next
Authentication & Limits
Built with