Documentation

gnome.technology Documentation

Welcome to the gnome.technology documentation. Here you'll find comprehensive guides and documentation to help you start working with our transaction categorization API as quickly as possible.

Getting Started

Get up and running with our transaction categorization API in minutes.

Quickstart Guide

API Reference

Detailed documentation for all API endpoints, parameters, and responses.

View API Reference

Core Concepts

Transaction Categorization

Our API uses advanced machine learning algorithms to categorize financial transactions into a hierarchical taxonomy of categories and subcategories. The categorization is based on transaction descriptions, amounts, and other metadata.

Example Request

POST /api/v1/categorize
Content-Type: application/json
Authorization: Bearer YOUR_API_KEY

{
  "transactions": [
    {
      "id": "tx_123456",
      "description": "STARBUCKS COFFEE #4321",
      "amount": 5.75,
      "date": "2023-04-15"
    }
  ]
}

Example Response

{
  "results": [
    {
      "id": "tx_123456",
      "category": "Food & Dining",
      "subcategory": "Coffee Shops",
      "confidence": 0.97
    }
  ]
}

SDK Examples

Installation

npm install fincat-api-sdk

Basic Usage

import { FincatAPI } from 'fincat-api-sdk';

// Initialize the client
const fincat = new FincatAPI({
  apiKey: 'YOUR_API_KEY',
  environment: 'production' // or 'sandbox'
});

// Categorize transactions
async function categorizeTransactions() {
  try {
    const result = await fincat.categorize([
      {
        id: 'tx_123456',
        description: 'STARBUCKS COFFEE #4321',
        amount: 5.75,
        date: '2023-04-15'
      }
    ]);
    
    console.log(result);
    // Output: [{ id: 'tx_123456', category: 'Food & Dining', subcategory: 'Coffee Shops', confidence: 0.97 }]
  } catch (error) {
    console.error('Error categorizing transactions:', error);
  }
}

categorizeTransactions();

Frequently Asked Questions

Need Help?

Can't find what you're looking for? Our support team is here to help.