Clay API + SDK

Simple API / SDK to enrich data with Clay.

Want to set up your own Clay proxy instead of using ours? Remix this val instead.

Pricing

By default, the API returns all enrichment data except employee count. Including employee count costs 5 additional Clay credits per row. Reach out to Val Town for pricing details.

Example usage

Enrich by Email

import { clay } from "https://esm.town/v/charmaine/clay-proxy/sdk.ts"; const result = await clay({ email: "charmainekmlee@gmail.com", source: "user_signup" }); console.log(result);

Enrich with Employee Count

import { clay } from "https://esm.town/v/charmaine/clay-proxy/sdk.ts"; // Include employee count data (costs 5 additional credits per row) const result = await clay({ email: "charmainekmlee@gmail.com", source: "user_signup", includeEmployeeCount: true }); console.log(result);

Enrich GitHub User

// NOTE: You need to set GITHUB_TOKEN as an environment variable to run this import { clay } from "https://esm.town/v/charmaine/clay-proxy/sdk.ts"; import { emailsFromGitHubUsername } from "https://esm.town/v/stevekrouse/github-user-email/index.ts"; // First get email from GitHub username const emails = await emailsFromGitHubUsername("charmaine"); const email = emails[0]; // Then enrich with Clay const result = await clay({ email, github_username: "charmaine", repo: "val-town/vt", source: "github_stargazer" }); console.log(result);

Input

  • email - Required - Email address to enrich
  • github_username - Optional - GitHub username
  • source - Optional - Data source
  • repo - Optional - Repository name
  • includeEmployeeCount - Optional - Set to true to include employee count data (costs 5 additional credits per row, defaults to false)

Output (if found)

  • person - Name
  • linkedin - LinkedIn URL
  • company - Company of employment
  • linkedin_data - LinkedIn profile data
  • funding - Funding stage
  • totalFunding - Total funding raised
  • employeeCount - Number of employees (only included when includeEmployeeCount: true)