​
1. Getting your API key

Get your API key from fingertip.com/account/api. Log in, generate a key, and use it during setup. Keep it secure.

​
2. Install Fingertip SDK

Get the Fingertip Node.js SDK.

npm install fingertip

​
3. Make your first API call

The easiest way to verify your setup is with a ping request.

import Fingertip from "fingertip";

const client = new Fingertip({
  apiKey: process.env["FINGERTIP_API_KEY"],
});

(async function () {
  const response = await client.api.v1.ping();

  if (response) {
    console.log("API connection successful:", response.message);
  }
})();

​
4. Error handling

Handle API errors with the built-in error types.

import Fingertip from "fingertip";

const client = new Fingertip({
  apiKey: process.env["FINGERTIP_API_KEY"],
});

(async function () {
  try {
    const response = await client.api.v1.ping();
    console.log("Success:", response);
  } catch (error) {
    if (error instanceof Fingertip.APIError) {
      console.error("API Error:", error.name, error.status);
    } else {
      console.error("Unexpected error:", error);
    }
  }
})();

​
Requirements

  • Node.js 16+
  • Fingertip API key

​
Repository

For more information, bug reports, or to contribute, visit the GitHub repository.