Using the API to search your data

You are able to search things like auctions, items, and more.  To do so, you simply pass an array of data when placing the applicable API calls.  For instance, searching for keywords in auctions, or items belonging to a particular auction or category.

The data for a single field inquiry has 3 parts.  The field, the operator, and the value.  The field is the internal field name for the database table field that you want to search on.  The operator is the type of comparisson you want to perform on that field.  And the value is the value you are comparing to that field.  You pass these parts in the form of an aray, being [field] => array('operator' => [operator], 'value' => [value]).  A JSON formatted string would look like:

{ "department_id": { "operator" : "equals", "value": 59 } }

 

The following operators may be used to perform different checks with the data:

 

Operator Description
equals To find a match equal to your value.
not_equal To find a match not equal to your value.
like To find a match that contains an exact match to your value.
less_than To find a match that is less than your value.
greater_than To find a match that is greater than your value.
less_than_equal To find a match that is less than, or equal to, your value.
greater_than_equal To find a match that is greater than, or equal to, your value.
full_search Performs a search on the field on each individual word to look for matches.
in To find a match that is within a list of possible values.

 

To perform a full search, you must specify a field that has full search capabilities.  These are usually titles, descriptions, and other large text fields.  Specifying a field that is not able to be searched on this way will result in an error.  This search does not search for conjunctions or other small words that are used frequently.