Search
GET /v2/search
Table of contents
Overview
Returns a list of objects, matching the provided search string.
Request URL: https://apirest.wyscout.com/v2/search
Example URL: https://apirest.wyscout.com/v2/search?query=totti&objType=player
Parameters
( * parameters are mandatory)
Name | Type | Default | Description |
---|---|---|---|
query * | string | null | The string to be matched with the competition's names |
objType * | string | null | Object to be retrieved (only the first type is considered). See Notes(1) for available objects |
gender | string | men | Values: men or women (default is men) |
Output
Property | Type | Condition | Value | Description |
---|---|---|---|---|
competitions | array | objType = competition | Dynamic | The list of retrieved competitions (see GET competitions/{wyId} for more info) |
teams | array | objType = team | Dynamic | The list of retrieved teams (see GET teams/{wyId} for more info) |
players | array | objType = player | Dynamic | The list of retrieved players (see GET players/{wyId} for more info) |
referees | array | objType = referee | Dynamic | The list of retrieved referees (see GET referees/{wyId} for more info) |
Notes
1. Available object types
Object | Description |
---|---|
competition | Competition details (see GET competitions/{wyId} for more info) |
team | Team details (see GET teams/{wyId} for more info) |
player | Player details (see GET players/{wyId} for more info) |
referee | Referee details (see GET referees/{wyId} for more info) |