Skip to main content

API

POST /search#

Searches the Hash DB with the specified parameters.
You can use any HTTP request method, but it is recommended to use POST.

Type: JSON
Required Headers: Content-Length
Note: Any status code other than 200 should be considered an error. The following JSON will be returned if an error has occurred:

{    "error": "invalid request json"}

This is currently the only error that can occur.

Request Fields (all are required, case insensitive):#

Field NameTypeDescription
search_termstringTerm to search for
number_of_resultsintHow many results should be returned on one "page"
resource_typestring (type)What type to search for (see list of types) e.g. ANY
page_numberintWhat page to return results from (starting from 0)

Example Request:#

{    "search_term": "azalea",    "number_of_results": 3,    "resource_type": "any",    "page_number": 0}

Response Fields:#

Field NameTypeDescription
resultsarray (result)The results returned from the search (see an example format below)
number_of_resultsintHow many results should be returned on one "page" (as specified by user)
page_numberintWhat page to return results from (starting from 0) (as specified by user)

Result Format:#

{    "hash": "00C736630357B43C",    "string": "[assembly:/_pro/design/actor/profession.template?/prof_sapienza_civilian_nakedguy.entitytemplate].pc_entitytype",    "type": "TEMP"}

Example Response:#

{    "number_of_results": 3,    "page_number": 0,    "results": [        {            "hash": "00800A1DAA3DB1B2",            "string": "azalea_green_a",            "type": "TEMP"        },        {            "hash": "00A48D280A10793D",            "string": "azalea_green_a",            "type": "TBLU"        },        {            "hash": "00200F50F4F10A24",            "string": "azalea_green_b",            "type": "TEMP"        }    ]}

List of Types:#

Same as Glacier 2 File Formats but with an added ANY type which will return all types.