FullContact.getPersonFromTwitter()

Retrieves contact information by Twitter username.

Usage

Hover over inputs/exits for more info.

var FullContact = require('machinepack-fullcontact');


// Retrieves contact information by Twitter username.

FullContact.getPersonFromTwitter({

apiKey: '00011122233344455',

twitter: 'janedoe',

queue: '1',

webhookUrl: 'https://mydomain.com/callback/listener',

webhookId: 'myId',

}).exec({

// An unexpected error occurred.

error: function (err) {

 

},

// FullContact says your API request was malformed

malformedRequest: function () {

 

},

// FulLContact says your API key is invalid or your rate limit has been reached.

apiKeyProblem: function () {

 

},

// FullContact says you have an invalid or missing query parameter.

queryParamProblem: function () {

 

},

// FullContact has queued the search and will have an answer shortly. If you don't want to wait, use the webhook input

queued: function () {

 

},

// FullContact says you have to wait 24 hours to try this query again.

wait24Hours: function () {

 

},

// OK.

success: function () {

 

},

});

Inputs

apiKey required

Your FullContact API key

'00011122233344455'
twitter required

The twitter name fo the person being looked up

'janedoe'
queue

Using this parameter notifies FullContact that the email address in question will be called later. It allows the API to make sure it has indexed the email address prior to the application needing it. When using this parameter, it will always return a response code of 202.

'1'
webhookUrl

The callback url you'd like the data to be posted back to.

'https://mydomain.com/callback/listener'
webhookId

You can enter anything you want here, we will just pass it back in the response. This allows you to track the webhook if you wish.

'myId'

Exits

error

An unexpected error occurred.

malformedRequest

FullContact says your API request was malformed

apiKeyProblem

FulLContact says your API key is invalid or your rate limit has been reached.

queryParamProblem

FullContact says you have an invalid or missing query parameter.

queued

FullContact has queued the search and will have an answer shortly. If you don't want to wait, use the webhook input

wait24Hours

FullContact says you have to wait 24 hours to try this query again.

success

OK.