index

Functions

createClient()

function createClient(apiKey, moduleParams?): BuiltWithClient;

Defined in: index.ts:71

Create a BuiltWith API client.

Parameters

apiKey

string

Your BuiltWith API key.

moduleParams?

Optional client configuration (e.g. response format).

responseFormat?

"xml" | "json" | "txt" | "csv" | "tsv" = ...

Returns

BuiltWithClient

A BuiltWithClient with methods for each BuiltWith API endpoint.

Example

import { createClient } from "builtwith-api";

const client = createClient(process.env.BUILTWITH_API_KEY!);

// Free lookup
const profile = await client.free("example.com");

// Domain lookup with filters
const details = await client.domain("example.com", {
  onlyLiveTechnologies: true,
});

// Multi-domain lookup
const multi = await client.domain(["example.com", "other.com"]);

References

BuiltWithClient

Re-exports BuiltWithClient

---

ClientOptions

Re-exports ClientOptions

---

CompanyToUrlParams

Re-exports CompanyToUrlParams

---

DomainParams

Re-exports DomainParams

---

ListsParams

Re-exports ListsParams

---

ResponseFormat

Re-exports ResponseFormat

---

TrendsParams

Re-exports TrendsParams

---

TrustParams

Re-exports TrustParams