Some details info
[ouya-store-api.git] / api / devs.ouya.tv / api-v1-search.rst
1 ====================================================
2 ``GET https://devs.ouya.tv/api/v1/search``
3 ====================================================
4
5 Search for games in the discover store.
6
7
8 HTTP request
9 ============
10 Protocol
11   ``https``
12 Method
13   ``GET``
14 Host
15   ``devs.ouya.tv``
16 Path
17   ``/api/v1/search``
18 Headers
19   Standard headers
20 GET parameters
21   ``auth_token``
22     Same as ``X-OUYA-AuthToken``
23   ``q``
24     Search word(s)
25
26
27 HTTP response
28 =============
29 Status code
30   ``200 OK``
31 Content-type
32   ``application/json; charset=utf-8``
33
34 The ``count`` property contains the number of games that matched the search
35 string, even if they are not all returned in the result list.
36 The search result list is limited to 20 or 40 games.
37
38 When the ``count`` is higher than the number of items in ``results``,
39 the OUYA will send a new search request to the API when another letter is added
40 to the search word.
41
42 If the ``count`` and ``results`` are the same, the OUYA will use the current
43 response and filter it for itself without asking the server again.
44
45 Example
46 -------
47 .. include:: api-v1-search.response.json
48    :code: