Search

GET http://api.contextvoice.com/1.2/resources/search

Parameters:

  • q - search term - it can be a keyword or a URL (required)
  • s - sort by (default: created_at; other options: hotness) (optional)
  • relevance - retrieve all the stories that are above the relevance threshold (min: 10, max: 100) (optional)
  • offset - start from a specific result in the result set
  • count - how many reactions will be included per page (default: 20; max: 100)
  • language - retrieve only the stories written in the specified language:
                      arabic-iso8859_6
                      bulgarian-iso8859_5
                      chinese-big5
                      danish
                      dutch
                      english
                      persian
                      finnish
                      french
                      german
                      hungarian
                      icelandic
                      italian
                      japanese-euc_jp
                      korean
                      norwegian
                      polish
                      portuguese
                      romanian
                      russian-iso8859_5
                      serbian-ascii
                      spanish
                      swedish
                      thai
                      turkish
                      ukrainian-koi8_u
  • apikey - your API key (required - get one now)

Response

Parameter Description Type/Values Always
offset the distance from the beginning of the result set
 non-negative integer yes
count number of items in the result set
 non-negative integer yes
total approximate value of the total result set
 non-negative integer
 yes
id id that uniquely identifies the resource in our system string (32 chars) yes
hotness unix timestamp indicating the hotness of the resource (the higher the timestamp the hottest the resource)
 integer yes
relevance relevance threshold for the result set
 integer (10-100)
 yes
published unix timestamp when the resource was created integer yes
created_at unix timestamp when the resource was added in our system integer yes
author
 resource author name
 string: story.comment.singular | photo.comment.singular | video.comment.singular | video.response.singular | comment.singular | resource.singular | blog.post.comment.singular yes
generator platform where the resource was created string: wordpress | blogger | hostedblogger | movabletype | typepad | hostedtypepad | nytimes | youtube | flickr | picasa | imdb | friendfeed | twitter | digg | hackernews | slashdot | reddit | delicious | stumbleupon | mixx yes
type resource type
 string: story.comment.singular | photo.comment.singular | video.comment.singular | video.response.singular | comment.singular | resource.singular | blog.post.comment.singular yes
url resource url
 string yes
title resource title string yes
content part of the resource content string yes

Sample requests:

http://api.contextvoice.com/1.2/resources/search/?q=apple&apikey=123456

http://api.contextvoice.com/1.2/resources/search/?q=http://mashable.com/2009/03/04/social-media-comments/&apikey=123456

http://api.contextvoice.com/1.2/resources/search/?q=microsoft&s=hotness&apikey=123456

http://api.contextvoice.com/1.2/resources/search/?q=ubervu&offset=25&count=50&relevance=70&apikey=123456

Sample responses

The XML response should look like this:

And the JSON response should look like this:

Sample code (Python)

version 13 as of 3 weeks ago by ubervu Admin

Comments

  1. Olaf Lederer – 5 months ago

    Nice and easy API, how about a language filter?
    Searching for english results is no problem, but what if I need only dutch language results?

  2. ubervu Admin – 5 months ago

    Hi Olaf,

    The language filter is on the TODO list. I'll ping you when it's available.

    Cheers!

  3. trimbitassorin – 3 weeks ago

    Nice job with this API!

    Please update the documentation by adding the "format" parameter :)

    Regards

    Sorin

Please sign in to post a comment.