General

Tutorials

API documentation

List

List the images present in your API. By default List returns information about 20 images for each call.

GET resource URL

https://wineengine.tineye.com/<company>/rest/list/

Notes

The list method’s output order is stable, so you can use offset and limit to implement pagination.

Parameters

In addition to the Common parameters there are:

Key Description
offset (optional) Skips that many images in the collection, defaults to 0. 0 means to not skip any items. Should be at least 0.
limit (optional) Limits the results to this many images, defaults to 20. -1 will return all items. Should be at least -1.

Request example

curl https://wineengine.tineye.com/<company>/rest/list/ --get     \
     -d "offset=1"                                                \
     -d "limit=3"

Response examples

JSON

{
  "status": "ok",
  "method": "list",
  "error": [],
  "result": [
    "path/folder/2.jpg",
    "path/folder/3.jpg"
  ]
}

XML

<?xml version="1.0" encoding="utf-8"?>
<data>
  <status>ok</status>
  <method>list</method>
  <error/>
  <result>
    <item>path/folder/2.jpg</item>
    <item>path/folder/3.jpg</item>
  </result>
</data>