FOOTBALL API V1

get

Endpoint Description

This endpoint allows users to search for football-related information globally based on a specified query. In this case, the query is set to "Barcelona", which will return relevant data associated with the search term.

Request Format

  • Method: GET

  • URL: https://apiv3.sportsapi360.com/football/api/v1/global/search

  • Query Parameters:

    • query (string): The search term used to find relevant football data. In this example, the query is set to "Barcelona".

Response Structure

The response from this endpoint will be in JSON format and consists of the following structure:

  • status (boolean): Indicates whether the request was successful.

  • statusCode (integer): A code representing the status of the request.

  • message (string): A message providing additional context about the request's status (may be empty).

  • response (array): An array containing the search results, where each result has the following properties:

    • id (integer): A unique identifier for the football entity.

    • name (string): The name of the football entity.

    • nameCode (string): A code representing the name of the football entity.

    • national (boolean): Indicates if the entity is national.

    • type (string): The type of entity (e.g., player, team).

    • gender (string): The gender associated with the entity.

    • country (object): An object containing country information:

      • alpha2 (string): The two-letter country code.

      • name (string): The name of the country.

    • score (integer): A score associated with the search result.

This structure provides a comprehensive overview of the search results related to the specified query.

Authorizations
HTTPRequired
Query parameters
querystringOptionalExample: Barcelona
Header parameters
x-api-keystringOptional
Responses
200

OK

text/plain
stringOptional
get
/football/api/v1/global/search
200

OK

Last updated