Getting Started with BidYard

Welcome to BidYard! This guide will help you integrate with the BidYard lead exchange platform.

What is BidYard?

BidYard is a compliance-first ping-post marketplace for home services leads (HVAC, Roofing, Plumbing). We help publishers monetize their lead traffic while ensuring buyers receive high-quality, compliant leads.

Quick Start Guide

Create Your Account

Create a Source

In your dashboard, create a new Source to represent your lead traffic. Configure the service types (HVAC, Roofing, Plumbing) and geographic areas.

Go to Sources

Set Up Consent Capture

Install the BidYard Consent Script on your lead forms to automatically capture compliance evidence.

View Consent Script Guide

Get Your API Credentials

Obtain your Source Token or HMAC credentials from your Source settings to authenticate API requests.

View Authentication Guide

Integrate the API

Use the BidYard API to submit leads and receive real-time bids from buyers.

View API Reference

Basic Concepts

Ping-Post Model

BidYard operates on a ping-post model. When you submit a lead, we "ping" buyers with the lead details (without revealing PII). Buyers respond with bids, and we run an auction to determine the winning buyer. You then "post" the full lead details to the winning buyer.

Sources

A Source represents where your leads come from (e.g., your website, landing page, or form). Each Source has its own API credentials and can be configured with different service types and geographic targeting.

Consent Evidence

BidYard requires consent evidence for all leads to ensure compliance with TCPA and other regulations. The easiest way to capture this is with the BidYard Consent Script, which automatically tracks user consent on your forms.

Service Types

BidYard currently supports three home services verticals:

HVAC - Heating, Ventilation, and Air Conditioning
Roofing - Roof repair, replacement, and installation
Plumbing - Plumbing services and repairs

Example Integration

Here's a basic example of submitting a lead to BidYard:

curl -X POST https://api.bidyard.dev/v1/leads \
  -H "Authorization: Bearer your_source_token" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]",
    "phone": "555-123-4567",
    "serviceType": "HVAC",
    "zipCode": "74103",
    "consentEvidenceId": "evidence_abc123"
  }'