SunlightLabs API

Your API keys

API Results Metadata

All API methods have a metadata parameter which is set to false by default.

By calling the methods with metadata=true, we provide additional information in the JSON or XML output about where these results come from (i.e., the labs), the ultimate source of data (e.g., echoditto dataset), and when the data were last updated.

These metadata serve two important purposes: first, helping one archive data one has received through the API, and second, indicating whether any important clerical information has been changed since the user last received it, without having to compare values for each field.

• Fieldname: apiurl
• Methods: all
• Description:the full URL used to call this method and get these particular results. Note that the order of parameters may differ from that the user had used.

JSON example:

apiurl: "http://api.sunlightlabs.com/people.getPersonInfo.php?entity_id=fakeopenID123"

XML example:

<apiurl>http://api.sunlightlabs.com/people.getPersonInfo.php?entity_id=fakeopenID123<apiurl>

• Fieldname: personupdate
• Methods: people.convertId, people.getDataItem, people.getPersonInfo
• Description: the date of the most recent update about any information about this person.

JSON example:

personupdate: "2007-02-16 22:05:08"

XML example:

<personupdate>2007-02-16 22:05:08<personupdate>

• Fieldname: datasource
• Methods: all
• Description:the ultimate source of the data.

JSON example:

datasource: "http://www.echoditto.com/zip2rep"

XML example:

<datasource>http://www.echoditto.com/zip2rep<datasource>