@getyetty-sdk/qonto

TypeScript client for the Qonto API, auto-generated from the official OpenAPI specification.

⚠️ Disclaimer

This package is not officially maintained by Qonto. It is auto-generated from the publicly available OpenAPI specification. While we strive to keep it up-to-date through daily automated updates, there may be occasional discrepancies or delays.

Use at your own risk. For production applications, always test thoroughly and consider the official Qonto documentation as the source of truth.

✨ Features

• 🔒 Fully typed TypeScript client
• 🤖 Auto-generated from the official Qonto OpenAPI spec
• 🔄 Daily automated updates to stay in sync with API changes
• 📦 Tree-shakable, zero runtime dependencies (standalone bundle)
• 🚀 ESM module

📋 Requirements

• Node.js >= 24.0.0

📥 Installation

npm install @getyetty-sdk/qonto

🛠️ Usage

Basic Setup

import { client } from '@getyetty-sdk/qonto';

// Configure the default client with your credentials
client.setConfig({
  baseUrl: 'https://thirdparty.qonto.com',
  headers: {
    Authorization: `${process.env.QONTO_ORG_SLUG}:${process.env.QONTO_SECRET_KEY}`,
  },
});

Making API Calls

import { getOrganization, listTransactions, listBankAccounts } from '@getyetty-sdk/qonto';

// Get organization details
const organization = await getOrganization();

// List transactions
const transactions = await listTransactions({
  query: {
    status: 'completed',
    per_page: 100,
  },
});

// List bank accounts
const accounts = await listBankAccounts();

Creating a Custom Client Instance

For convenience, you can use the createClientWithCredentials helper:

import { createClientWithCredentials, getOrganization } from '@getyetty-sdk/qonto';

const qonto = createClientWithCredentials(
  process.env.QONTO_ORG_SLUG!,
  process.env.QONTO_SECRET_KEY!,
);

// Use the custom client
const { data } = await getOrganization({
  client: qonto,
});

Or create a fully custom client with advanced configuration:

import { createClient, createConfig, getOrganization } from '@getyetty-sdk/qonto';

const qonto = createClient(
  createConfig({
    baseUrl: 'https://thirdparty.qonto.com',
    headers: {
      Authorization: `${process.env.QONTO_ORG_SLUG}:${process.env.QONTO_SECRET_KEY}`,
    },
  }),
);

// Use the custom client
const { data } = await getOrganization({
  client: qonto,
});

Sandbox Environment

For development and testing, you can use the Qonto sandbox environment:

import { createSandboxClientWithCredentials } from '@getyetty-sdk/qonto';

const qontoSandbox = createSandboxClientWithCredentials(
  process.env.QONTO_SANDBOX_SLUG!,
  process.env.QONTO_SANDBOX_KEY!,
);

📚 API Documentation

For detailed API documentation, please refer to the official Qonto API docs.

📄 License

MIT