Method: search/getSearchResults
This methods makes possible to search media in fotolia image bank. Full search capabilities are available through the API.
Authentication
This method does not require authentication.
HTTP method
This method is called with HTTP method GET.
Arguments
| Argument | Type | Element (array) | Valid Values | Default Value | Detail | ||
|---|---|---|---|---|---|---|---|
search_parameters |
array | see below | |||||
search_parameters[language_id] |
Int |
|
2 |
|
|||
search_parameters[words] |
string | list of words | none | keyword search words can also be media_id using # to search for some media ( ex : #20 #21 #22) |
|||
search_parameters[creator_id] |
int | valid creator id | none | Search by creator | |||
search_parameters[cat1_id] |
int | valid category1 id | none | Search by representative category get valid categories1 ids width getCategories1 |
|||
search_parameters[cat2_id] |
int | valid category2 id | none | Search by conceptual category get valid valid category2 id's width getCategories2 |
|||
search_parameters[gallery_id] |
int | valid gallery id | none | Search by gallery get valid galleries id's with getGalleries |
|||
search_parameters[country_id] |
int | valid country id | none | Search by country get valid country id's with getCountries |
|||
search_parameters[media_id] |
int | existing media id | none | Search by media id | |||
search_parameters[model_id] |
int | existing media id | none | Search by same model | |||
search_parameters[serie_id] |
int | existing media id | none | Search by same serie | |||
search_parameters[similia_id] |
int | existing media id | none | Search by similar media (similia) | |||
search_parameters[filters][content_type:photo] |
int | 0 - 1 | 0 | Search for photos | |||
search_parameters[filters][content_type:illustration] |
int | 0 - 1 | 0 | Search for illustrations | |||
search_parameters[filters][content_type:vector] |
int | 0 - 1 | 0 | Search for vectors | |||
search_parameters[filters][content_type:video] |
int | 0 - 1 | 0 | Search for videos | |||
search_parameters[filters][content_type:all] |
int | 0 - 1 | 1 | Search for all files (default) | |||
search_parameters[filters][offensive:2] |
int | 0 - 1 | 0 | Explicit/Charm/Nudity/Violence included | |||
search_parameters[filters][isolated:on] |
int | 0 - 1 | 0 | Isolated contents | |||
search_parameters[filters][panoramic:on] |
int | 0 - 1 | 0 | Panoramic images | |||
search_parameters[filters][license_L:on] |
int | 0 - 1 | 0 | L size available | |||
search_parameters[filters][license_XL:on] |
int | 0 - 1 | 0 | XL size available | |||
search_parameters[filters][license_XXL:on] |
int | 0 - 1 | 0 | XXL size available | |||
search_parameters[filters][license_V_HD1080:on] |
int | 0 - 1 | 0 | Full HD video size available | |||
search_parameters[filters][license_V_HD720:on] |
int | 0 - 1 | 0 | HD ready video size available | |||
search_parameters[filters][license_X:on] |
int | 0 - 1 | 0 | Extended license available | |||
search_parameters[filters][orientation] |
string |
|
all |
|
|||
search_parameters[filters][age] |
string |
|
all |
|
|||
search_parameters[filters][video_duration] |
string |
|
all |
|
|||
search_parameters[filters][max_price_xs] |
int |
|
all |
|
|||
search_parameters[filters][max_price_x] |
int | X price <= value you defined | |||||
search_parameters[filters][colors] |
string | comma separated listed of hexadecimal colors (without any # prefix) | |||||
search_parameters[filters][has_releases] |
string | true - false | people filter | ||||
search_parameters[order] |
string |
|
relevance |
|
|||
search_parameters[limit] |
Int | 1 to 64 | 32 | maximum number of media returned | |||
search_parameters[offset] |
int | 0 to max results | 0 | Start position in query | |||
search_parameters[thumbnail_size] |
int |
|
110 |
|
|||
search_parameters[detail_level] |
int |
|
none |
When this parameter is sent and set to 1, the method will return for each content :
|
|||
search_parameters[secure_urls] |
Int | 0 | Returns HTTPS urls | ||||
result_columns |
array |
|
One of more items of this list |
|
Fields you want to have included in the answer | ||
Returned Values
| Element (path) | Name | Type | Description | |||||
|---|---|---|---|---|---|---|---|---|
| / | nb_results |
int | total number of result | |||||
| /[n]/ | id |
int | media unique ID | |||||
| /[n]/ | title |
string | media title (used for title tag) | |||||
| /[n]/ | creator_id |
int | media creator unique id | |||||
| /[n]/ | creator_name |
string | media creator name | |||||
| /[n]/ | thumbnail_url |
string | media thumbnail url | |||||
| /[n]/ | thumbnail_html_tag |
string | media thumbnail html tag | |||||
| /[n]/ | thumbnail_width |
int | media thumbnail width (px) | |||||
| /[n]/ | thumbnail_height |
int | media thumbnail height(px) | |||||
| /[n]/licenses/[n]/ | name |
string | media license name | |||||
| /[n]/licenses/[n]/ | price |
int | media license price (credit) | |||||
| When detail_level=1 only : | ||||||||
| /[n]/ | nb_views |
int | media views number | |||||
| /[n]/ | nb_downloads |
int | media downloads number | |||||
| /[n]/ | keywords |
string | Media keywords, comma separated | |||||
Example Query
GET http://API_KEY@api.fotolia.com/Rest/1/search/getSearchResults?search_parameters%5Bwords%5D=test&search_parameters%5Blanguage_id%5D=2&search_parameters%5Blimit%5D=2
Example Response
{
"nb_results":459,
"0":{
"id":1384045,
"title":"scientist with test tube radiant gradient bg",
"creator_name":"Jose Gil",
"creator_id":6537,
"thumbnail_url":"http:\/\/static-p1.fotolia.com\/jpg\/00\/01\/38\/40\/110_F_1384045_waKUmRkPuVSQSK9T4lDNc5YvkqSp4x.jpg",
"thumbnail_html_tag":"",
"thumbnail_width":81,
"thumbnail_height":110,
"licences":[
{
"name":"M",
"price":1
},
{
"name":"L",
"price":2
},
{
"name":"X",
"price":50
}
]
},
"1":{
"id":1247723,
"title":"antique tube tester",
"creator_name":"James Steidl",
"creator_id":140159,
"thumbnail_url":"http:\/\/static-p2.fotolia.com\/jpg\/00\/01\/24\/77\/110_F_1247723_MB9BPAu0TMbhI2UEUNCQKCRpvXdEyR.jpg",
"thumbnail_html_tag":"",
"thumbnail_width":74,
"thumbnail_height":110,
"licences":[
{
"name":"M",
"price":1
},
{
"name":"L",
"price":2
},
{
"name":"XL",
"price":3
},
{
"name":"X",
"price":20
}
]
}
}
Error Codes
001: Service currently unavailable- The requested service is temporarily unavailable.
002: Failed to parse request- The request could not be parsed.
010: Missing API Key- The API key passed is missing.
011: Invalid API Key- The API key passed is not valid or has expired.
031: Invalid Method- This method does not exist in the method list.
032: Method not Available- This method is not available for this API Key.
2001: Invalid Language ID- The language ID passed is not valid or doesn't exist in the fotolia available language list.
2101: Invalid Thumbnail Size- The thumbnail size passed is not valid or doesn't exist in the fotolia available thumbnail size list.


