centroid

centroid

Unofficial node.js module for the Centroid Media API.

• Centroid Media
• API documentation

DEPRECATED

The centroid module is deprecated because the remote API is no longer available. All described methods will fail.

Example

var centroid = require ('centroid') ('apikey', 'privatekey');

centroid.persons.search (
  {
    country: 'us',
    lang: 'en',
    fullname: 'Barack Obama',
    sources: 'linkedin'
  },
  function (err, res) {
    if (err) { return console.log (err); }
    console.log (res);
  }
);

Installation

npm install centroid

Configuration

You need API credentials to get access to the methods, which can be requested on the Centroid website. When you have those, specify them in your code:

var centroid = require ('centroid') ('apiKey', 'privateKey', 10000);

param	type	required	description
apiKey	string	yes	Your API key
privateKey	string	yes	Your private key
timeout	integer	no	Time limit to wait for response, default 10000 ms (20 sec)

Searching a person across many sources may take a while to complete, therefore a timeout of 20 seconds is not extremely high.

Methods

callbackFunction ( err, [data] )

Each method requires the last parameters to be a callback function. This function receives the results or error when there is trouble.

When there is an error, err is instanceof Error with related information. When the request went fine, err is null and data is set.

callbackFunction( err, data ) {
  if (!err) {
    console.log (data);
  } else {
    console.log (err);
    console.log (err.stack);
  }
}

Errors

The err parameter can receive these errors:

message	description
No API key	No apikey was provided
No private key	No privatekey was provided
Disconnected	The API disconnected too early
HTTP error	The API returned a HTTP error
No response	The API returned no data
Invalid response	The API returned invalid data
API error	The API returned an error
Request failed	The request cannot be made
No results	No results were returned

Additional information

These properties can be provided in the Error instance. Not all of these are present in each type of error.

property	description
.stack	The stack trace
.message	The error message

            |

.httpCode | ie. 404 .httpHeaders | Object with http headers .requestError | The .request error .response | API response body .errorCode | API error code .errorString | API error message .code | Error code from HTTP module

getCurrentRate ( callback )

Get the current rate.

centroid.getCurrentRate (callback);

Result:

30

persons.getActiveSources ( props, callback )

Get a list of sources that are active for the specified country.

Props

property	type	required	description
country	string	required	Two-letter ISO country code, i.e. 'us'
lang	string	required	Two-letter ISO language code, i.e. 'en'

centroid.getActiveSources (props, callback);

Result: (truncated)

[
  {
    name: 'Twitter',
    id: 'twitter',
    category: 'socialnetworks',
    popular: 1
  },
  {
    name: 'LinkedIn',
    id: 'linkedin',
    category: 'socialnetworks',
    popular: 1
  }
]

persons.getPopularSources ( props, callback )

Get a list of popular sources that are active for the specified country.

Props

property	type	required	description
country	string	required	Two-letter ISO country code, i.e. 'us'
lang	string	required	Two-letter ISO language code, i.e. 'en'

centroid.getPopularSources (props, callback);

Result: (truncated)

[
  { name: 'Twitter', id: 'twitter', category: 'socialnetworks' },
  { name: 'LinkedIn', id: 'linkedin', category: 'socialnetworks' },
  { name: 'Facebook', id: 'facebook', category: 'socialnetworks' },
  { name: 'MySpace', id: 'myspace', category: 'socialnetworks' }
]

persons.getCategories ( props, callback )

Get a list of categories that are active for the specified country.

Props

property	type	required	description
country	string	required	Two-letter ISO country code, i.e. 'us'
lang	string	required	Two-letter ISO language code, i.e. 'en'

centroid.getCategories (props, callback);

Result: (truncated)

[
  { name: 'Personal',
    id: 'wow_data',
    sources: 
     [
       { name: 'Related persons', id: 'related', popular: 1 },
       { name: 'Facts', id: 'facts', popular: 1 },
       { name: 'Tags', id: 'tags', popular: 1 },
       { name: 'Email addresses', id: 'emailaddresses', popular: 1 },
       { name: 'Phone numbers', id: 'phonenumbers', popular: 1 },
       { name: 'Documents', id: 'docs', popular: 1 }
     ]
  }
]

persons.search ( props, callback )

Search for a person.

Props

property	type	required	description
country	string	required	Two-letter ISO country code, i.e. 'us'
lang	string	required	Two-letter ISO language code, i.e. 'en'

Requires at least one of:

categories   Comma-separated list of category IDs.
sources      Comma-separated list of source IDs.
set          'popular' (default) or 'all'.

Requires at least one of:

firstname    Person's firstname.
fullname     Person's first and last names.

centroid.persons.search (
  {
    country: 'us',
    lang: 'en',
    fullname: 'Barack Obama',
    sources: 'linkedin'
  },
  output
);

Result:

[
  {
    name: 'LinkedIn',
    id: 'linkedin',
    category: 'socialnetworks',
    found: 27,
    result_location: 'http://www.kgbpeople.com/api/linkedin?firstname=Barack',
    results: 
     [
       {
         name: 'Barack Obama',
         photo: 'https://media.licdn.com/mpr/mpr/shrink_120_120/p/2/000/1a3/129/3a73f4c.jpg',
         headline: 'President of the United States of America',
         current: 'President at United States of America',
         past: 'US Senator at US Senate (IL-D), State Senator at Illinois State Senate, Senior Lecturer in Law at University of Chicago Law School',
         location: 'Washington D.C. en omgeving, Verenigde Staten',
         education: 'Harvard University, Columbia University in the City of New York, Occidental College',
         industry: 'Administración gubernamental',
         url: 'http://www.linkedin.com/in/barackobama'
       }
     ]
  }
]

Unlicense

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to http://unlicense.org

Author

Franklin van de Meent