Quickstart

Get started with Bounty Lab in minutes using the TypeScript SDK.

Prerequisites

• Node.js 18+ or Bun runtime
• A Bounty Lab account with an API key

Get Your API Key

1. Sign in to the Bounty Lab Dashboard
2. Create an organization (if you haven’t already)
3. Navigate to your organization settings
4. Go to “API Keys” and click “Generate New Key”
5. Copy and securely store your API key

Important: API keys are only shown once. Save them securely!

Install the SDK

npm install @bountylab/bountylab
# or
pnpm add @bountylab/bountylab
# or
bun add @bountylab/bountylab

Create a Client

import Bountylab from "@bountylab/bountylab";

const client = new Bountylab({
  apiKey: process.env.BOUNTYLAB_API_KEY,
});

Make Your First API Call

Search for Users

// Search for TypeScript developers in San Francisco
const result = await client.searchUsers.search({
  query: "typescript engineer",
  filters: {
    field: "resolvedCity",
    op: "Eq",
    value: "San Francisco",
  },
  maxResults: 10,
});

console.log(`Found ${result.count} users`);
result.users.forEach((user) => {
  console.log(`- ${user.login}: ${user.bio}`);
});

Search for Repositories

// Find popular React component libraries
const result = await client.searchRepos.search({
  query: "react component library",
  filters: {
    op: "And",
    filters: [
      { field: "language", op: "Eq", value: "TypeScript" },
      { field: "stargazerCount", op: "Gte", value: 1000 },
    ],
  },
  maxResults: 10,
});

console.log(`Found ${result.count} repositories`);
result.repositories.forEach((repo) => {
  console.log(
    `- ${repo.ownerLogin}/${repo.name} (${repo.stargazerCount} stars)`,
  );
});

Retrieve Specific Users or Repos

// Get users by login
const result = await client.rawUsers.byLogin({
  logins: ["torvalds", "gaearon"],
});

console.log(`Found ${result.count} users`);

// Get repositories by full name
const repos = await client.rawRepos.byFullname({
  fullNames: ["facebook/react", "microsoft/typescript"],
});

// Force refresh to get latest data
const freshUser = await client.rawUsers.byLogin({
  logins: ["octocat"],
  forceRefresh: true,
});

Next Steps

• Explore search filters: See the Search Guide for advanced filtering options
• Query data in real-time: Use the GraphQL proxy to run custom queries
• Review API reference: Check out the full API documentation
• Build your application: Integrate Bounty Lab into your developer tools, analytics, or recruiting platform

Need Help?

• API Documentation: api.bountylab.io/docs
• Support: Contact us through the dashboard