Get started
API Endpoint
"<datazapp api endpoint URL>"
The Demography Append likely refers to a process or service related to appending demographic information to existing data. In the context of data analysis or marketing, appending demographic information involves adding demographic variables such as age, gender, income, education level, marital status, etc., to a dataset.
To use this API, you need an API key. Please contact us at [email protected] to get your API key.
Demography Append API Request
Query Parameters
Request{ "ApiKey": "API Key", "AppendModule": "DemographyAppend", "OutputColumn": [ "Age", "Education", "Marital_Status", "Gender", "Ethnicity", "Income", "Occupation", "Presence_of_Child", "Home_Owner", "LOR", "Dwelling_Type", "Home_Value", "Dog_Owner", "Cat_Owner", "Diet_Weight_Loss", "Golf_Enthusiasts", "Travel_Cruise_Vacations", "Travel_International", "Arts_Cultural", "Animal_Welfare", "Childrens_Causes", "Environmental_Causes", "International_Aid", "Religious", "Veterans", "NumberOfChildren", "Party-Leaning_D", "Party-Leaning_R", "Political_Donor", "Unregistered_Voter", "Signal_Accredited_Investor", "Signal_EV_Purchase", "Signal_High_Networth", "Propensity_to_Give", "Signal_Seller_Score", "Signal_Solar_Intenders", "Loan_Amount_Range", "HomePurchase_Range", "NLTV", "CREDIT_RANGE" ], "Data": [ { "Address": "3x Uxxxn Sxx", "City": "Pxxxn", "FirstName": "DxxxxE", "LastName": "MxxxR", "Zip": "0xxx0", "Email": "[email protected]", "Phone": "156xxxxx78" }, { "Address": "3x Uxxxn Sxx", "City": "Woxhxxvexn", "FirstName": "Alexxnxer", "LastName": "Fexixo", "Zip": "1xxx1", "Email": "[email protected]", "Phone": "146xxxxx88" } ] or --For MD5 Emails "Data": [ { "MD5": "MD5Data" } ] or --For SHA Emails "Data": [ { "SHA": "SHAData" } ] }
| Parameter | Type | Required | Description |
|---|---|---|---|
| APIKey | String | Required | Issued by Datazapp Support. |
| AppendModule | String | Required | Value should be “DemographyAppend.” |
| Data Object (Array): An array containing the following parameters for each record. | |||
| Address | String | Required | Valid United States postal address. |
| City | String | Required | City name. |
| FirstName | String | Required | First name of the person. |
| LastName | String | Required | Last name of the person. |
| Zip | String | Required | 5-digit Zip code associated. Zip or Zip+4 is accepted. |
| String | Optional | An individual’s email address can be from any domain (e.g., [email protected]). | |
| Using MD5 or SHA Emails | String | Optional | Append Using MD5 or SHA Emails |
| Phone | String | Optional | Contact number of an individual |
Output Column Specification
| Column Name | Description |
| Age | Age group of the individual |
| Education | Indicates the education of the individual in the household |
| Marital_Status | Married or single |
| Gender | Male or female |
| Ethnicity | Ethnicity of an individual |
| Income | How much an individual earn |
| Occupation | Occupation of the Individual |
| Presence_of_Child | Indicates the known presence/absence of children age 0-17 in the household |
| Home_Owner | Home Owner or Renter |
| LOR | LOR(Length of Residence) Indicates the total time a household has lived at their current address. |
| Dwelling_Type | Dwelling Type refers to the primary structure or style of residential housing. typically single-family homes are not connected to anydwellings & Multi-family dwellings include apartments, condominiums, townhouses, and duplexes. |
| Home_Value | provide the value of the home |
| Dog_Owner | Likely presence of Dog(s) in household |
| Cat_Owner | Cats Likely presence of Cat(s) in household |
| Diet_Weight_Loss | A member of the household has an interest in Dieting or Weight Loss |
| Golf_Enthusiasts | Plays or Interest in Golf & Golf related merchandise |
| Travel_Cruise_Vacations | Travelers with affinity for cruise trips |
| Travel_International | Interest in international travel destinations |
| Arts_Cultural | Contributors to organizations promoting art and culture |
| Animal_Welfare | Givers towards animal welfare, adoption, veterinary services, & preventing animal cruelty |
| Childrens_Causes | Financial supporters of organizations dedicated to children’s well-being |
| Environmental_Causes | Givers promoting environmental stewardship, education, and sustainable practices |
| International_Aid | Charitable donors giving towards foreign and international aid |
| Religious | Donors to religious causes and organizations |
| Veterans | Financial supporters of veterans’ affairs causes |
| NumberOfChildren | A numeric value representing how many number of children an individual have |
| Party-Leaning_D | Indicates a likely Democratic Party supporter |
| Party-Leaning_R | Indicates a likely Republican Party supporter |
| Political_Donor | Identified as having donated to political campaigns |
| Unregistered_Voter | Likely eligible to vote but not currently registered |
| Signal_Accredited_Investor | Flagged as meeting the criteria for accredited investor status |
| Signal_EV_Purchase | likely intent or history of purchasing an electric vehicle |
| Signal_High_Networth | Modeled as having high personal or household net worth |
| Propensity_to_Give | It indicates how likely someone is to engage in acts of giving or generosity | Signal_Seller_Score | Predictive score estimating the likelihood of a person being a home seller.
4x(Very High) 3x(High) 2x(Medium) 1x(Low) 0x(Least Likely) |
| Signal_Solar_Intenders | Identified as likely to install or interested in solar energy solutions
Solar-High Intent (4x) Solar-Believer (3x) Solar-Ready (2x) Solar-Qualified (1x) |
| Loan_Amount_Range | Categorized range showing how much loan amount the borrower has taken. |
| HomePurchase_Range | Value range indicating the price bracket of the home purchased. |
| NLTV | Net Loan-to-Value ratio range showing the loan amount compared to the property value. |
| CREDIT_RANGE | Credit score bracket representing the borrower’s creditworthiness category. |
Response
Query Parameters
Response{ "header": { "Status": 0, "Message": null }, "ResponseDetail": { "App": 0, "Token": "IxxxxS", "Data": [ { "Age": "33", "Education": "B", "Marital_Status": "M", "Gender": "M", "Ethnicity": "", "Income": "", "Occupation": "", "Presence_of_Child": "", "Home_Owner": "H", "LengthOfResidence": "17", "Dwelling_Type": "S", "Home_Value": "$150001-$200000", "Dog_Owner": "", "Cat_Owner": "", "Diet_Weight_Loss": "", "Golf_Enthusiasts": "", "Travel_Cruise_Vacations": "", "Travel_International": "Y", "Arts_Cultural": "", "Animal_Welfare": "", "Childrens_Causes": "", "Environmental_Causes": "", "International_Aid": "", "Religious": "Y", "Veterans": "", "Contributor_General": "", "Party_Leaning_D": "D", "Party_Leaning_R": "R", "Political_Donor": "D", "Unregistered_Voter": "", "Signal_Accredited_Investor": "Y", "Signal_EV_Purchase": "", "Signal_High_Networth": "", "Propensity_to_Give": "68", "Signal_Seller_Score": "2x - Medium", "Signal_Solar_Intenders": "Solar-Qualified (1x)", "Loan_Amount_Range": "$175k-$199k", "HomePurchase_Range": "Above 1M", "NLTV": "54", "CREDIT_RANGE": "EXCELLENT", "Tag": "", "FirstName": "DxxxxE", "LastName": "MxxxR", "Address": "3xUxxxn xx", "City": "Pxxxxn", "Zip": "0xxx0", "AlterFirstName": null, "AlterLastName": null, "AlterAddress": null, "AlterCity": null, "AlterZip": null, "Matched": false }, { "Age": "36", "Education": "", "Marital_Status": "S", "Gender": "M", "Ethnicity": "", "Income": "", "Occupation": "", "Presence_of_Child": "N", "Home_Owner": "H", "LengthOfResidence": "7", "Dwelling_Type": "S", "Home_Value": "", "Dog_Owner": "", "Cat_Owner": "", "Diet_Weight_Loss": "", "Golf_Enthusiasts": "", "Travel_Cruise_Vacations": "", "Travel_International": "", "Arts_Cultural": "", "Animal_Welfare": "", "Childrens_Causes": "", "Environmental_Causes": "", "International_Aid": "", "Religious": "", "Veterans": "", "Contributor_General": "", "Party_Leaning_D": "D", "Party_Leaning_R": "", "Political_Donor": "D", "Unregistered_Voter": "", "Signal_Accredited_Investor": "Y", "Signal_EV_Purchase": "", "Signal_High_Networth": "", "Propensity_to_Give": "72", "Signal_Seller_Score": "2x - Medium", "Signal_Solar_Intenders": "Solar-Qualified (1x)", "Loan_Amount_Range": "$175k-$199k", "HomePurchase_Range": "Above 1M", "NLTV": "54", "CREDIT_RANGE": "EXCELLENT", "Tag": "", "FirstName": "Alxxxxxer", "LastName": "Fexxxxno", "Address": "axxx Wxxu sx", "City": "Woxxxxen", "Zip": "1xxxx1", "AlterFirstName": null, "AlterLastName": null, "AlterAddress": null, "AlterCity": null, "AlterZip": null, "Matched": false } ], "OrderAmount": "$0.135", "Count": 26, "Message": null, "ProcessedTime": "766 milliseconds" }, "Status": true, "Message": null }
| Field | Type | Description |
|---|---|---|
| Following Parameters returned in Header: | ||
| Status | Integer | Indicate header status |
| Message | String | Indicate type of error |
| Following Parameters returned in ResponseDetails: | ||
| Token | String | System generated reference. |
| Below Parameters will be returned as Data Object in Array Format: | ||
| Age | String | Provide the age of an individual, ranging from 1 to 100 |
| Education | String | Provide the education code of the individual in the
household Values:- A = Completed High School B = Completed College C = Completed Graduate School D = Attended Vocational/Technical U = Unknown |
| Marital_Status | String | The marital status code in the household Values :- M = Married S = Single A = Inferred Married B = Inferred Single |
| Gender | String | Provide Gender of Individual Values:- U = Unknown F = Female M = Male |
| Ethnicity | String | Ethnicity of an individual |
| Income | String | How much an individual earn |
| Occupation | String | Provide Occupation of Individual |
| Presence_of_Child | String | Indicates the known presence/absence of children age 0-17 in
the Household Values :- Y = Children Present N = No Children Present |
| Home_Owner | String | Provide whether the individual is a homeowner or
not Values:- 9 = Probable Home Owner H = Home Owner R = Renter |
| LOR | String | Indicates the total time a household has lived at their
current address. Values: 00-99 |
| Dwelling_Type | String | Dwelling Type refers to the primary structure or style of
residential housing. Typically single-family homes are not connected to any dwellings & Multi-family
dwellings include apartments, condominiums, townhouses, and duplexes. Values: M = Multiple Family Dwelling Unit S = Single Family Dwelling Unit U = Unknown |
| Home_Value | String | Provide the value of Home Value :- Numeric Value |
| Dog_Owner | String | Is Dog Owner or not Values :- Y = Dog Owner U= Unknown |
| Cat_Owner | String | Is Cat Owner or not Values :-Y = Cat Owner U= Unknown |
| Diet_Weight_Loss | String | Someone has an interest an dieting/weight loss Values:- Y = yes N = no |
| Golf_Enthusiasts | String | Someone has an interest a Golf_Enthusiasts Values:- Y = yes N = no |
| Travel_Cruise_Vacations | String | Travelers with affinity for cruise trips Values:- Y = yes N = no |
| Travel_International | String | Someone in the household has taken an International
Vacation Values:- Y = yes N = no |
| Arts_Cultural | String | Individuals in these households support Arts or Cultural
causes financially Values:- Y = yes N = no |
| Animal_Welfare | String | Individuals in these households support Animal Welfare
causes financially Values:- Y = yes N = no |
| Childrens_Causes | String | Individuals in these households support Animal Welfare
causes causes related to children Values:- Y = yes N = no |
| Environmental_Causes | String | Individual Support for the Environment Values:- Y = yes N = no |
| International_Aid | String | Individuals in these households support various international
aid causes financially Values:- Y = yes N = no |
| Religious | String | Someone in the household has an interest in reading
religious/inspirational items. Values:- Y = yes N = no |
| Veterans | String | Individuals in these households financially support various causes
related to veterans. Values:- Y = yes N = no |
| NumberOfChildren | String | A numeric value representing how many number of children an individual have |
| Party-Leaning_D | String | Indicates a likely Democratic Party supporter |
| Party-Leaning_R | String | Indicates a likely Republican Party supporter |
| Political_Donor | String | Identified as having donated to political campaigns |
| Unregistered_Voter | String | Likely eligible to vote but not currently registered |
| Signal_Accredited_Investor | String | Flagged as meeting the criteria for accredited investor status |
| Signal_EV_Purchase | String | likely intent or history of purchasing an electric vehicle |
| Signal_High_Networth | String | Modeled as having high personal or household net worth |
| Propensity_to_Give | String | Provide the numeric value representing how an individual can donate Values = numeric value |
| Signal_Seller_Score | String | Predictive score estimating the likelihood of a person being a home seller. 4x(Very High) 3x(High) 2x(Medium) 1x(Low) 0x(Least Likely) |
| Signal_Solar_Intenders | String | Identified as likely to install or interested in solar energy solutions
Solar-High Intent (4x) Solar-Believer (3x) Solar-Ready (2x) Solar-Qualified (1x) |
| Loan_Amount_Range | String | Categorized range showing how much loan amount the borrower has taken |
| HomePurchase_Range | String | Value range indicating the price bracket of the home purchased. |
| NLTV | String | Net Loan-to-Value ratio range showing the loan amount compared to the property value. |
| CREDIT_RANGE | String | Credit score bracket representing the borrower’s creditworthiness category. |
| FirstName | String | First name (name of person in household) |
| LastName | String | Last name (name of person in household) |
| Address | String | Street Address. |
| City | String | City name. |
| Zip | String | Zip code associated. Zip or Zip+4 is accepted. |
| OrderAmount | String | Amount of count |
| Count | String | Number of count |
| ProcessedTime | String | Processing time |
| Status | String | True |
| Message | String | Error Message in case of any error. |
Errors
The API uses the following error codes:
| Error Code | Meaning |
|---|---|
| Module does not exist. | The specified module does not exist or Invalid AppendModule Name. |
| User not found. | Invalid API Key or The user associated with the API key was not found |
| Getting 401 Error. | The user does not have access to this API |
| Append Request not found | Invalid Token: The specified append request could not be found |
| Improper JSON Data. Please check. | The JSON data in the request does not match the expected format. |
| It seems like API has an issue. Please contact Support. | There is an issue with the API. Contact the [email protected] |
