Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Finage

Scalekit connector
Open markdown

The Finage connector lets your AI agent act in each user's Finage account. Each user connects their own Finage API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.

Tools
60
What they doRead · write · destructive
60 · 0 · 060 read0 write0 destructive
Users sign in with

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  3. Create the Finage connection

    In AgentKit > Connections, create a Finage connection. The name you give it is the connection_name your code passes. See Configure connections.

  4. Authorize a user and make your first call

    quickstart.mts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    import { createInterface } from 'node:readline/promises'
    const scalekit = new ScalekitClient(
    process.env.SCALEKIT_ENVIRONMENT_URL,
    process.env.SCALEKIT_CLIENT_ID,
    process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    const connector = 'finage'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Finage:', link)
    const rl = createInterface({ input: process.stdin, output: process.stdout })
    await rl.question('Press Enter after authorizing...')
    rl.close()
    // Make your first call
    const result = await actions.executeTool({
    connector,
    identifier,
    toolName: 'finage_crypto_market_cap_ranks_list',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their Finage credentials there. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • finage_balance_sheet_statements_getGet a US company's balance sheets, annual or quarterly.Read-only

    Get Balance Sheet Statements

    Get a US company's balance sheets, annual or quarterly. Returns statements with assets, liabilities and equity.

    Inputs

    symbolstringrequired
    US Stock symbol. Example: AAPL.
    limitinteger
    Number of statements to return. Example: 4.
    periodstring
    Statement period: annual (default) or quarter. Example: quarter.one of annualquarter
  • finage_bond_rate_getGet the latest yield (percent) of a US Treasury bond, for example DGS10 for the 10-year.Read-only

    Get US Bond Rate

    Get the latest yield (percent) of a US Treasury bond, for example DGS10 for the 10-year. Returns the rate and date.

    Inputs

    symbolstringrequired
    Bond symbol, for example DGS1, DGS2, DGS10 or DGS30. Example: DGS10.
  • finage_ca_stock_aggregates_getGet OHLC bars for a Canadian stock over a date range at a chosen bar size.Read-only

    Get Canadian Stock Aggregates

    Get OHLC bars for a Canadian stock over a date range at a chosen bar size. Returns bars with open, high, low, close, volume and timestamp.

    Inputs

    from_datestringrequired
    Start date (YYYY-MM-DD). Example: 2026-01-05.
    symbolstringrequired
    Canadian stock symbol, for example BMO. Example: BMO.
    timestringrequired
    Bar size unit. Example: 1day.one of 1min5min15min30min45min1h2h4h1day1week1month
    to_datestringrequired
    End date (YYYY-MM-DD). Example: 2026-01-09.
    date_formatstring
    Date format of the results: dt for datetime or ts for timestamp (default). Example: dt.one of dtts
    dbt_filterboolean
    Set to true to apply the st/et time filter to every day instead of only trimming the start and end. Example: false.
    etstring
    End time of day in UTC, for example 21:00. Example: 21:00.
    limitinteger
    Limit of the results. Default is 100, maximum allowed limit is 5000. Please set a limit if you are using the API in the production. Example: 100.
    sortstring
    Sort by timestamp: asc (oldest first, the default) or desc. Example: asc.one of ascdesc
    ststring
    Start time of day in UTC, for example 14:30. Example: 14:30.
  • finage_ca_stock_last_price_getGet the latest price of a Toronto Stock Exchange share such as BMO.Read-only

    Get Canadian Stock Last Price

    Get the latest price of a Toronto Stock Exchange share such as BMO. Returns price and timestamp.

    Inputs

    symbolstringrequired
    Canadian stock symbol, for example BMO. Example: BMO.
  • finage_cash_flow_statements_getGet a US company's cash flow statements, annual or quarterly.Read-only

    Get Cash Flow Statements

    Get a US company's cash flow statements, annual or quarterly. Returns statements with operating, investing and financing cash flows.

    Inputs

    symbolstringrequired
    US Stock symbol. Example: AAPL.
    limitinteger
    Number of statements to return. Example: 4.
    periodstring
    Statement period: annual (default) or quarter. Example: quarter.one of annualquarter
  • finage_crypto_aggregates_getGet OHLCV bars for a crypto pair over a date range at a chosen bar size.Read-only

    Get Crypto Aggregates

    Get OHLCV bars for a crypto pair over a date range at a chosen bar size. Returns open, high, low, close, volume and timestamp per bar.

    Inputs

    from_datestringrequired
    Start date (YYYY-MM-DD). Example: 2026-01-05.
    multiplyintegerrequired
    Number of time units per bar, for example 1 with time day for daily bars. Example: 1.
    symbolstringrequired
    Crypto pair, for example BTCUSD. Example: BTCUSD.
    timestringrequired
    Bar size unit. Example: day.one of minutehourdayweekmonthquarteryear
    to_datestringrequired
    End date (YYYY-MM-DD). Example: 2026-01-09.
    limitinteger
    Limit of the results. Default is 100, maximum allowed limit is 50000. Please set a limit if you are using the API in the production. Example: 100.
    sortstring
    Sort by timestamp: asc (oldest first, the default) or desc. Example: asc.one of ascdesc
  • finage_crypto_convertConvert an amount between two cryptocurrencies at the real-time rate.Read-only

    Convert Cryptocurrency

    Convert an amount between two cryptocurrencies at the real-time rate. Returns the converted value. Use finage_forex_convert for fiat currencies.

    Inputs

    amountnumberrequired
    Amount to convert. Example: 100.
    from_currencystringrequired
    Crypto symbol to convert from, for example BTC. Example: BTC.
    to_currencystringrequired
    Crypto symbol to convert to, for example ETH. Example: ETH.
  • finage_crypto_detailed_price_getGet a detailed real-time snapshot of a crypto pair: price, 24-hour change, volume and market data.Read-only

    Get Crypto Detailed Price

    Get a detailed real-time snapshot of a crypto pair: price, 24-hour change, volume and market data. Returns the detailed price.

    Inputs

    symbolstringrequired
    Crypto pair, for example btcusd. Example: btcusd.