# BuyerCaddy Documentation

> Documentation for BuyerCaddy

## API Reference: Overview
- [Quick Start](https://buyercaddy-api.readme.io/reference/quick-start.md): Welcome to the **BuyerCaddy Public API**. In this guide you will
- [Recommended Workflow](https://buyercaddy-api.readme.io/reference/workflow.md)
- [Errors & Rate Limits](https://buyercaddy-api.readme.io/reference/errors-rate-limits.md)

## API Reference: BuyerCaddy Public API
- Vendors
  - [Get vendors](https://buyercaddy-api.readme.io/reference/getvendors.md): Search vendors by company name or domain.
  - [Get vendor products](https://buyercaddy-api.readme.io/reference/getproducts.md): Use this to find all products associated with a single vendor.
- Products
  - [Search for products](https://buyercaddy-api.readme.io/reference/searchproductspaged.md): Either search or categoryId is required
  - [Returns product timeseries data (detections) aggregated by month](https://buyercaddy-api.readme.io/reference/findproducttimeseries.md)
- Dataset
  - [Get all products](https://buyercaddy-api.readme.io/reference/getproductscsv.md): Download all products dataset
  - [Get all categories](https://buyercaddy-api.readme.io/reference/getcategorycsv.md): Download all categories dataset
- Companies
  - [Search companies](https://buyercaddy-api.readme.io/reference/findstackcompanies.md)
  - [Get competitors](https://buyercaddy-api.readme.io/reference/getcompetitors.md): This API yields up to 50 competitors per subject company.
  - [Get cohort](https://buyercaddy-api.readme.io/reference/getcohort-1.md): BuyerCaddy allows for 3 different comparison cohorts for each company being benchmarked.
  - [Get usage of products by custom cohort](https://buyercaddy-api.readme.io/reference/getusageproductscustomcohort.md): This is the API that delivers what products are installed in the cohort companies according to the given company.
  - [Company Products](https://buyercaddy-api.readme.io/reference/companyproductsjsonpaged.md): This is the API that returns all the detected technology and product installs at a company.
  - [Company Products In Use](https://buyercaddy-api.readme.io/reference/companyproductsinuse.md): This is the API that helps to detect whether a product (s) is in use at a company.
  - [Company Products](https://buyercaddy-api.readme.io/reference/companyproducts.md): This is the API that returns all the detected technology and product installs at a company.
  - [Get Related Product by custom cohort](https://buyercaddy-api.readme.io/reference/getrelatedproductsbycustomcohort.md): Use this to find all related (complementary/competitor/related) products associated with a single product.
  - [Get Related Product](https://buyercaddy-api.readme.io/reference/getrelatedproducts.md): Use this to find all related (complementary/competitor/related) products associated with a single product.
  - [Company Products](https://buyercaddy-api.readme.io/reference/companyproductsjson.md): This is the API that returns all the detected technology and product installs at a company. The format is JSONL
  - [Get company feed](https://buyercaddy-api.readme.io/reference/getcompanyfeed.md): This API yields up to 50 news per subject company.
  - [Get company firmographics](https://buyercaddy-api.readme.io/reference/getcompanyfirmographics.md): This API returns details about the company by domain
  - [Get usage metric](https://buyercaddy-api.readme.io/reference/getusage.md): This is the API that delivers the benchmarking results.
- Dictionary
  - [Get Product Categories](https://buyercaddy-api.readme.io/reference/getproductcategories.md): Load categories assigned to products in the application
  - [Get Industries](https://buyercaddy-api.readme.io/reference/getindustries.md): Load industries registered in the application
- AI
  - [Search customers of product](https://buyercaddy-api.readme.io/reference/aifindcustomersofproducts.md): Searches customers of product according to the query in natural language
  - [Search tech stacks for a company](https://buyercaddy-api.readme.io/reference/aifindtechstacksforcompany.md): Searches stacks according to the query in natural language
- Credits
  - [Get balance](https://buyercaddy-api.readme.io/reference/getcreditsbalance.md): Get current balance
  - [Get credits report](https://buyercaddy-api.readme.io/reference/getcreditsreport.md): Get credits report for a date range.  From and to params might be omitted to get report for the whole period of API usage. Please, note that the report is being actualized once an hour.

## API Reference: MCP Server
- [MCP Inspector](https://buyercaddy-api.readme.io/reference/mcp-inspector.md): This guide explains how to use **MCP Inspector** to connect to the MCP server and authenticate using your own API key.
- [BuyerCaddy MCP Server - Real Data](https://buyercaddy-api.readme.io/reference/mcp-server-real-data.md)
- [MCP Server - Docs for IDE AI agents](https://buyercaddy-api.readme.io/reference/mcp.md)

## API Reference: Vendors
- [Vendors](https://buyercaddy-api.readme.io/reference/vendors.md): Search vendors by company name or domain.
- [Vendor Products](https://buyercaddy-api.readme.io/reference/vendor-products.md): Find products associated with a single vendor.

## API Reference: Products
- [Products - Search](https://buyercaddy-api.readme.io/reference/as.md): Either `search` **or** `categoryId` is required.
- [Products - Dataset (CSV)](https://buyercaddy-api.readme.io/reference/products-dataset-csv.md): Download the full product catalog.

## API Reference: Companies
- [Companies - Search](https://buyercaddy-api.readme.io/reference/companies-search.md): Find companies by firmographic and stack signals.
- [Company - Competitors](https://buyercaddy-api.readme.io/reference/company-competitors.md)
- [Company - Cohorts](https://buyercaddy-api.readme.io/reference/company-cohorts.md)
- [Company - Benchmarking](https://buyercaddy-api.readme.io/reference/usage-metrics-benchmarking.md): Benchmark **Technology Usage** within a cohort of competitors or peers for a given company.
- [Company - Tech Stacks](https://buyercaddy-api.readme.io/reference/company-products-csv-json-paged-json.md): Retrieve detected technologies and product installs for a company.
- [Company - Related Products](https://buyercaddy-api.readme.io/reference/related-products-by-company-product.md)
- [Company - Feed](https://buyercaddy-api.readme.io/reference/company-feed-newssignals.md)
- [Company - Firmographics](https://buyercaddy-api.readme.io/reference/company-firmographics.md)

## API Reference: Dictionary
- [Dictionary - Product Categories](https://buyercaddy-api.readme.io/reference/dictionary-product-categories.md)
- [Dictionary - Industries](https://buyercaddy-api.readme.io/reference/dictionary-industries.md)

## API Reference: AI
- [AI Endpoints — Best Practices](https://buyercaddy-api.readme.io/reference/ai-endpoints-best-practices.md)
- [Find Customers of Products](https://buyercaddy-api.readme.io/reference/ai-find-customers-of-products.md)
- [Find Tech Stacks for a Company](https://buyercaddy-api.readme.io/reference/find-tech-stacks-for-a-company.md)