Skip to main content

Installation

Get started with Guido in a few simple steps.

Prerequisites

Before getting started, make sure you have:

  • Node.js version 20.0 or higher
  • Bun (optional but recommended for better performance)
  • A Guido account (sign up at guido.ai)

SDK Installation

With npm

npm install @guido/racing-sdk

With bun

bun add @guido/racing-sdk

With yarn

yarn add @guido/racing-sdk

Initial Setup

1. Create an Account

Head to guido.ai to create your account and get your API keys.

2. Configure Your Credentials

Create a .env file at the root of your project:

GUIDO_API_KEY=your_api_key_here
GUIDO_API_SECRET=your_api_secret_here

3. Initialize the SDK

import { GuidoClient } from '@guido/racing-sdk';

const client = new GuidoClient({
apiKey: process.env.GUIDO_API_KEY,
apiSecret: process.env.GUIDO_API_SECRET,
});

Verify Installation

Test that everything works correctly:

// Connection test
const status = await client.healthCheck();
console.log('Guido SDK connected:', status.ok);

Next Steps

Need Help?