# Get Buyer Insights

Endpoint: GET /api/v1/buyer-insights
Version: 1.0.0

## Header parameters:

  - `Accept` (string)
    Example: "application/json"

  - `token` (string)
    Example: "{API Key}"

## Query parameters:

  - `streetNumber` (string, required)
    Lead's street number.

  - `streetAddress` (string, required)
    Lead's street address.

  - `city` (string, required)
    Lead’s city name.

  - `state` (string, required)
    Lead's state name (two-letter abbreviation, e.g., NY).

  - `zip` (string, required)
    Lead’s zip code (5 digit code).

  - `lastName` (string)
    Lead’s last name. Used for Lead Integrity Score calculation.

  - `leadIntegrityScoreOn` (boolean)
    Used for activating Lead Integrity information being returned in response.

  - `salesHacksOn` (boolean)
    Used for activating Sales Hacks information being returned in response.

## Response 200 fields (application/json):

  - `timestamp` (string)
    The timestamp when the response was returned. It is provided in ISO 8601 format.
    Example: "2024-08-20T14:30:00Z"

  - `surePayScore` (integer,null)
    Represents SurePay™ Score.
    Example: 1

  - `elevateScore` (integer,null)
    Represents Elevate Score.
    Example: 2

  - `buyerInsights` (object)

  - `buyerInsights.savvyShopperScore` (integer,null)
    Score for Savvy Shopper category.
    Example: 2

  - `buyerInsights.brandLoyalistScore` (integer,null)
    Score for Brand Loyalist category.
    Example: 3

  - `buyerInsights.trendsetterScore` (integer,null)
    Score for Trendsetter category.
    Example: 3

  - `buyerInsights.budgetsavvyBuyerScore` (integer,null)
    Score for Budget-Savvy Buyer category.
    Example: 4

  - `buyerInsights.qualityFirstBuyerScore` (integer,null)
    Score for Quality First Buyer category.

  - `buyerInsights.impulseShopperScore` (integer,null)
    Score for Impulse Shopper category.
    Example: 1

  - `buyerInsights.popularPicksScore` (integer,null)
    Score for Popular Picks category.
    Example: 5

  - `accuracyCode` (string)
    Represents Accuracy Code.
    Enum: "P", "H", "G", "N"

  - `primaryOwner` (string,null)
    Full name of the primary owner.
    Example: "John M Doe"

  - `secondaryOwner` (string,null)
    Full name of the secondary owner.
    Example: "Jane Doe"

  - `ownerOccupied` (boolean,null)
    Indicates whether the property is occupied by the owner.
    Example: true

  - `homeBuiltYear` (string,null)
    The year the primary structure was built.
    Example: "1990"

  - `yearsInHome` (string,null)
    The number of years the primary owner has owned the property.
    Example: "16"

  - `county` (string,null)
    County name.
    Example: "Douglas"

  - `subdivision` (string,null)
    Subdivision name.
    Example: "Castle Oaks"

  - `school` (string,null)
    School district name.
    Example: "Somerville"

  - `propertyType` (string,null)
    General property type description.
    Example: "Residential"

  - `areaBuildingSize` (string,null)
    Total square feet of all structures on the property.
    Example: "3023"

  - `scructurePresent` (boolean,null)
    Indicates whether the structure is present at the provided address.
    Example: true

  - `leadIntegrityScore` (integer,null)
    Indicates lead’s quality. Evaluates such parameters, as zoning classification, owner occupied, structure present, surname match. The parameter is returned if  parameter = true in query.
    Example: 7

  - `leadIntegrityDefects` (array,null)
    Indicates lead’s quality. Evaluates such parameters, as zoning classification, owner occupied, structure present, surname match. The parameter is returned if  parameter = true in query.
    Example: ["surname"]

  - `salesHacks` (object,null)

  - `salesHacks.surePayHack` (string,null)
    Represents Sales Hack based on SurePay™ Score.

  - `salesHacks.elevateHack` (string,null)
    Represents Sales Hack based on Elevate Score.

  - `salesHacks.buyerInsightHacks` (object)

  - `salesHacks.buyerInsightHacks.savvyShopperHack` (string,null)
    Sales Hack based on Savvy Shopper Score.

  - `salesHacks.buyerInsightHacks.brandLoyalistHack` (string,null)
    Sales Hack based on Brand Loyalist Score.

  - `salesHacks.buyerInsightHacks.trendsetterHack` (string,null)
    Sales Hack based on Trendsetter Score.

  - `salesHacks.buyerInsightHacks.budgetsavvyBuyerHack` (string,null)
    Sales Hack based on Budget-Savvy Buyer Score.

  - `salesHacks.buyerInsightHacks.qualityFirstBuyerHack` (string,null)
    Sales Hack based on Quality First Buyer Score.

  - `salesHacks.buyerInsightHacks.impulseShopperHack` (string,null)
    Sales Hack based on Impulse Shopper Score.

  - `salesHacks.buyerInsightHacks.popularPicksHack` (string,null)
    Sales Hack based on Popular Picks Score.

## Response 400 fields (application/json):

  - `error` (string)
    Example: "Bad Request"

  - `statusCode` (integer)
    Example: 400

  - `message` (array)
    Example: ["state must be a string","state should not be empty"]

## Response 401 fields (application/json):

  - `error` (string)
    Example: "Unauthorized"

  - `statusCode` (integer)
    Example: 401

  - `message` (string)
    Example: "Invalid API Key"

## Response 404 fields (application/json):

  - `error` (string)
    Example: "Not Found"

  - `statusCode` (integer)
    Example: 404

  - `message` (string)
    Example: "Cannot GET /api/v1/buyer-insights"

## Response 500 fields (application/json):

  - `error` (string)
    Example: "Internal Server Error"

  - `statusCode` (integer)
    Example: 500

  - `message` (string)
    Example: "Unexpected server error occurred. Please try again later."