Fikun API

Fikun's API Documentation 

List Info

Returns the information for a given list id

URI Resource

http://api.fikun.com/list/list_id.format

Formats

json, xml, rss, atom, php

Required Parameters

  • list_id — list identificator
  • format — format of the response

Optional Parameters

  • none

Response Values

  • id — list id
  • title — list title
  • link — list link
  • description — list short description
  • image — list image
  • items — number of items of the list
  • user — list creator
  • user_link — list creator profile link
  • user_avatar — list creator avatar

Example

http://api.fikun.com/list/1.json

Will return information for the list with ID 1

Comments [0]

Item Threads

Returns the list of comments for a given review id

URI Resource

http://api.fikun.com/thread/review_id.format

Formats

json, xml, rss, atom, php

Required Parameters

  • review_id — review ID
  • format — format of the response

Optional Parameters

  • sort — STRING: specifies the order of the comments returned. Values accepted are self-explanatory: random, date_desc (default), date_asc
  • offset — INT: specifies the offset of the returned items in the list for that order
  • limit — INT [0-10]: specifies the limit of items to return, default is 5
  • upvoted — BOOL: specifies whether the commenter upvoted the review

Response Values

  • comment_id — comment id
  • comment_link — link to the comment
  • review_id — review id
  • review_link — link to the review
  • item_name — title of the item reviewed
  • item_id — id of the item reviewed
  • item_link — link to the item reviewed
  • date — date the comment was added
  • upvote — whether the commenter upvoted or not the review
  • user — commenter nick
  • user_link — commenter profile link
  • user_avatar — commenter avatar
  • title — comment title
  • comment — comment itself

Example

http://api.fikun.com/thread/1688.json

Will return all comments to review ID 1688

Comments [0]

Item Prices

Returns the list of prices for a given item ID

URI Resource

http://api.fikun.com/prices/item_id.format

Formats

json, xml, rss, atom, php

Required Parameters

  • item_id — item identification
  • format — format of the response

Optional Parameters

  • sort — STRING: specifies the order of the prices returned. Values accepted are self-explanatory: id_desc (default), id_asc, price_desc, price_asc
  • offset — INT: specifies the offset of the returned items in the list for that order
  • limit — INT [0-10]: specifies the limit of items to return, default is 5

Response Values

  • id — price id
  • price — price multiplied by 100 to avoid decimals (4900 = 49.00, 3250 = 32.50)
  • currency — currency ISO name
  • title — full title
  • link — link of the item

Example

http://api.fikun.com/prices/1150.json

Will return all prices for item with ID 1150.

 

Will return all items from user alex, within category 100 (all books), tagged as fiction, marked as 'have' true and limited to 3 items

Comments [0]

Item Reviews

Return reviews given by users to an item.

URI Resource

http://api.fikun.com/reviews/item_id.format

Format

json, xml, rss, atom, php

Required Parameters

  • item_id — item identificator
  • format — format of the response

Optional Parameters

  • none

Return Values

  • id — item identificator
  • review_id — the id of the review
  • review_link — the link of the review
  • comment — the review itself
  • tags — user given tags for this item
  • date — date of the review (the date it was added)
  • user — nick of the user
  • title — title of the item
  • comments — number of comments to this review
  • upvotes — number of upvotes to this review
  • status — have or wish
  • image_large — link to the large image of the item
  • image_medium — link to the medium image of the item
  • image_small — link to the small image of the item

Example

http://api.fikun.com/reviews/1150.json

User reviews of the item 1150 (Apple iPad)

Comments [0]

More

We are working actively on this API. If you wish to know more or things are not working properly just drop us your comments to our email or Twitter

Thanks!

Comments [0]

API Response Codes

Being RESTful it is logic to provide info about the request with HTTP headers. We provide few options to keep it very simple.

  • 200 OK: Everything is good.
  • 400 Bad Request: Your input can not be recognized. Check it.
  • 404 Not Found:: Your input returned no results.

Comments [0]

API Formats

The API provides data in five different standard and/or widely-used formats. Just use the one you prefer:

  • JSON (Default): a lightweight computer data interchange format (wikipedia).
  • XML: a markup language and a set of rules for encoding documents (wikipedia).
  • RSS: a XML document used for web syndication (wikipedia).
  • Atom: another XML document used for web syndication (wikipedia).
  • PHP: a lightweight serialized string used in PHP (PHP.net).

As noted, JSON is preferred as it is lightweight and commonly available in almost every platform or programming language.

Also, RSS and Atom references are not fully 100% yet.

Comments [0]

User Info

Return public information about a profile if it's public.

URI Resource

http://api.fikun.com/userinfo/user_name.format

Formats

json, xml, rss, atom, php

Required Parameters

  • user_name — user public nick
  • format — format of the response

Optional Parameters

  • none

Response Values

  • user_id — id of the user
  • user_name — nick of the user
  • link — profile url
  • avatar — avatar url
  • web — website information
  • info — short profile bio
  • reputation — user reputation

Example

http://api.fikun.com/userinfo/alex.json

Will retrieve info for user name "alex"

Comments [0]

User Items

Returns the list of items for a given user name.

URI Resource

http://api.fikun.com/users/user_name.format

Formats

json, xml, rss, atom, php

Required Parameters

  • user_name — user public nick
  • format — format of the response

Optional Parameters

  • id — INT: id of the concrete item you want
  • ids — STRING: multiple ids of concrete items you want, separated by comma
  • sort — STRING: specifies the order of the items returned. Values accepted are self-explanatory: random, date_add_desc (default), date_add_asc, name_desc, name_asc, rating_desc and rating_asc
  • category — INT: specifies the category of the items in the returned list
  • tags — STRING: specifies the tags of the items in the returned list, separated by comma
  • name — STRING: specifies the name of the items in the returned list
  • search — STRING: searches (into name and tags) of the items in the returned list
  • have — BOOL: specifies only items marked as owned
  • wish — BOOL: specifies only items marked as wished
  • comments — BOOL: includes personal review of the items returned
  • date_add (YYYY-MM-DD-HH-II-SS): specifies the date the item was added
  • rating — INT [0-10]: specifies the rating given, 0 to 10, and only owned items can be rated
  • offset — INT: specifies the offset of the returned items in the list for that order
  • limit — INT [0-10]: specifies the limit of items to return, default is 5
  • images — STRING: the url of the images to return. Values can be: false (default, wont return any), large, medium, small or all (will return all three sizes)
  • rating_max — INT [0-10]: specifies the maximun rating (only for owned items)
  • rating_min — INT [0-10]: specifies the minimum rating (only for owned items)
  • finished — BOOL: specifies finished status of items (only for owned items and certain categories)

Response Values

  • id — item global ID
  • item — item title
  • item_link — global link of the item
  • category — of the item
  • review_id — this user review ID for this item
  • review_link — link of the comment
  • review — the comment the user wrote
  • tags — used by the user to tag this item
  • status — have or wish
  • date_add — the datetime this user added the item
  • rating — the rating given by the user to the item (if any, and only if status equals have)
  • image_large — link to the large image of the item
  • image_medium — link to the medium image of the item
  • image_small — link to the small image of the item
  • comments — number of comments to the review
  • upvotes — number of upvotes to the review

Example

http://api.fikun.com/users/alex.json?category=100&tags=fiction&have=t...

Will return all items from user alex, within category 100 (all books), tagged as fiction, marked as 'have' true and limited to 3 items

 

 

Comments [0]

Documentation Index

Fikun provides a simple RESTful API for developers and/or anyone interested in using Fikun available data.

Currently there are just a few public read-only methods but write methods as well as private methods will be available in the future.

  1. Methods
    1. User Items
    2. User Info
    3. User Lists
    4. User Social Graph
    5. Item Browse
    6. Item Prices
    7. Item Reviews
    8. Item Threads
    9. List Info
    10. List Items
    11. OpenSearch
  2. Formats
  3. Response Codes
  4. More
  5. Applications

Comments [0]