TrendFeed API v2.0

Purpose

URL

Authentication

The API requires that every request authenticate itself via the inclusion of a valid API key, passed via a required key parameter, and any request that does not include one will fail with an http 401 status code. For brevity, this required parameter is not repeatedly documented for every API call below.

You can get your personal API key from the TrendSpottr Edit Account page. If you don't have a TrendSpottr account, you can get one by filling out the form on the TrendSpottr Registration Page and creating a TrendSpottr account.

Note that each account is only permitted one API key. If you generate a new key (via the button on the Edit Account page), it will replace your existing key any and any programs or scripts that use the previous API Key will fail until they are updated with the new value.

If you have any questions regarding the API or how to get access, please contact api@trendspottr.com for assistance.

Usage Limits

This API is available only under a contract with TrendSpottr. For details and pricing please contact us at api@trendspottr.com

Once authorized, you can track your usage via the TrendSpottr API dashboard.

API Terms of Use

By using the TrendSpottr API, you and, if applicable, the company you represent (collectively, "you"), accept and agree to be bound by the TrendSpottr API Terms of Use. It is important that you read these Terms as they form a legal agreement between you and ShawKing Data, Inc., operating as TrendSpottr.

Sample Code

A sample php script, trendfeedAPI-demo, is available that demonstrates how to call the TrendSpottr TrendFeed API via curl in PHP. Once downloaded, edit it to insert your personal API key, available from the Edit Account page, then run it with the PHP interpreter perform a search and parse the result.

Methods

This API supports the following methods:

• searchArticles
• getArticles
• getFeedList
• searchFeedList
• getFeedID

All string values provided to the endpoint must be encoded in UTF-8 format. All strings returned will be encoded similarly. All integers returned by the methods should be treated as 64-bit integers.

All API calls will include a string parameter called “key”. There is a unique apiKey value associated with each TrendSpottr user. Passing the apiKey allows the API key to perform the action on behalf of a specific user.

All parameters to the functions are to be sent as normal url parameters. All data returned will be json encoded and will decode into a single object. All return values will included a string property called “status” which can have one of two values:

• “OK”: Means that the call succeeded and the additional return values specified for the individual methods exist.
• “ERROR”: Means the call failed. If the method requested a change, it will not have been processed. The returned object will contain only one additional field:
• error_msg: a string describing the error

searchArticles

{
    "status": "OK",
    "matching_articles": [
        {
            "id": 291099,
            "title": "New MIT study claims 'range anxiety' fears about electric vehicles are overblown",
            "description": "New MIT study claims 'range anxiety' fears about electric vehicles are overblown A new study from MIT claims that range anxiety fears are overblown -- but while that may be true, it doesn't mean there aren't significant issues between EVs and widespread adoption. Read full article here",
            "author_name": "Bruce Whealton",
            "provider_name": "Future Wave Tech Info Blog",
            "provider_url": "futurewavewebdevelopment.com",
            "link": "http:\/\/futurewavewebdevelopment.com\/wp\/new-mit-study-claims-range-anxiety-fears-about-electric-vehicles-are-overblown\/",
            "thumbnail_url": "http:\/\/futurewavewebdevelopment.com\/wp\/wp-content\/uploads\/2016\/08\/Range-Anxiety-300x166.jpg",
            "thumbnail_width": 300,
            "thumbnail_height": 166,
            "pub_date": "2016-08-18T12:02:23+00:00",
            "trending_level": "High",
            "feed_id": 1706,
            "feed_group": "Automotive",
            "feed_name": "Electric Vehicles"
        }
    ]
}

getArticles

{
    "status": "OK",
    "articles": [
        {
            "id": 291099,
            "title": "New MIT study claims 'range anxiety' fears about electric vehicles are overblown",
            "description": "New MIT study claims 'range anxiety' fears about electric vehicles are overblown A new study from MIT claims that range anxiety fears are overblown -- but while that may be true, it doesn't mean there aren't significant issues between EVs and widespread adoption. Read full article here",
            "author_name": "Bruce Whealton",
            "provider_name": "Future Wave Tech Info Blog",
            "provider_url": "futurewavewebdevelopment.com",
            "link": "http:\/\/futurewavewebdevelopment.com\/wp\/new-mit-study-claims-range-anxiety-fears-about-electric-vehicles-are-overblown\/",
            "thumbnail_url": "http:\/\/futurewavewebdevelopment.com\/wp\/wp-content\/uploads\/2016\/08\/Range-Anxiety-300x166.jpg",
            "thumbnail_width": 300,
            "thumbnail_height": 166,
            "pub_date": "2016-08-18T12:02:23+00:00",
            "trending_level": "High"
        }
    ],
    "paging_cursor": 291099
}

getFeedList

searchFeedList

{
    "status": "OK",
    "matching_feeds": [
        {
            "feed_id": 1670,
            "feed_group": "Tech & Telecom",
            "feed_name": "Internet of Things"
        },
        {
            "feed_id": 1576,
            "feed_group": "Healthcare",
            "feed_name": "Digital and Connected Health"
        },
        {
            "feed_id": 1671,
            "feed_group": "Tech & Telecom",
            "feed_name": "IoT Infrastructure"
        },
        {
            "feed_id": 1646,
            "feed_group": "Security",
            "feed_name": "InfoSec and Cybersecurity"
        }
    ]
}

getFeedID

{
    "status": "OK",
    "feed_id": 1706
}

Error Responses

In the case of an error, api calls will return a http status code greater than or equal to 400 and a json object that will contains 2 properties: status, that will always be set to the string ERROR, and error_msg, that describes the error. For example:

{
    "status": "ERROR",
    "error_msg": "Invalid count. Must be an integer between 1 and 100."
}