Fikun API

Fikun's API Documentation 
« Back to blog

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)

Leave a comment...