Social Handle Append Documentation

Social Handle Append Overview

Datafinder's Social Handle Append API service enables you to programmatically append Social Handles to your customer or prospect email addresses.

Inputs and output:

For a complete list of inputs please see the "Parameters" section. For a complete list of outputs, please see the "Output Fields" section.

Request URL


https://api.datafinder.com/v2/qdf.php?k2={your-key}&service=social

Parameters


Config Parameters

Use the config parameters to adjust elements like the output language.

Name Description Required?
k2 Your api key Yes
service Which API service to use. Use "social" in this case. Yes
output Specify json or xml output responses. Default is JSON.
Example: output=json

Search Parameters

Any parameter that begins with a "d_" is a search parameter. We will use these parameters to try and match an individual or household. Some search parameters will not return results if used by themselves, such as d_last or d_first. If a search parameter requires another, it will be noted in the table below.

NOTE: d_first and d_last are required for an individual level match.

Name Description
d_email Valid email address
Example: d_email=account_name@domain.com

Output Fields


Api results will follow the schema shown below and will include:

  • version - api version
  • query-id - id unique to each query
  • results - list of append results
  • input-query - list of input search parameters and their values
  • num-results - number of match records for the given search parameters
  • query-time - how long the processing took
  • page-time - how long the lookup took

Fields returned for each records in the "results":

Name Description What is returned
FirstName First name First name
LastName Last name Last name
EmailAddr Email address Email address
FBName The name of the Facebook user Usually a first and last name
FBUID The Facebook ID for a user An integer, typically like 1446039785
FBURL The Facebook URL for viewing a profile https://facebook.com/some.name

Output schema in JSON:

{
  "datafinder": {
    "version": "2.0",
    "query-id": "xxxxxx",
    "results": [
      {
        "key": "value"
      }
    ],
    "input-query": {
      "key": "value"
    },
    "num-results": 1,
    "query-time": "0.000",
    "page-time": "0.000"
  }
}
       

If we cannot match the input search parameters to a record then no results will be returned. The result would appear as follows:

{
  "datafinder": {
    "version": "2.0",
    "query-id": "xxx",
    "input-query": {
      "FirstName": "John",
      "LastName": "Doe",
      "EmailAddr": "john.doe@domain.com"
    },
    "num-results": 0,
    "query-time": "0.138",
    "page-time": "0.193"
  }
}
           

Example Queries and Response


Search for social handles using an email address:

https://api.datafinder.com/v2/qdf.php?k2=key&service=social&d_email=john.doe@domain.com

{
  "datafinder": {
    "version": "2.0",
    "query-id": "b999a3acdc941aa030d87530a180c425",
    "results": [
      {
        "EmailAddr": "john.doe@domain.com",
        "FBUID": "1446039788",
        "FBName": "John Doe",
        "FBURL": "\/john.doe",
        "FirstName": "John",
        "LastName": "Doe"
      }
    ],
    "input-query": {
      "EmailAddr": "john.doe@domain.com",
      "Username": "john.doe",
      "Domain": "domain.com"
    },
    "num-results": 1,
    "query-time": "0.029"
  }
}