> For the complete documentation index, see [llms.txt](https://docs.sportsapi360.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sportsapi360.com/football-docs/api-collection-football/football-api-v1.md).

# FOOTBALL API V1

## Global Search

> \### 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\
> &#x20;   \
> \- \*\*URL\*\*: \`<https://apiv3.sportsapi360.com/football/api/v1/global/search\\`\\>
> &#x20;   \
> \- \*\*Query Parameters\*\*:\
> &#x20;   \
> &#x20;   \- \`query\` (string): The search term used to find relevant football data. In this example, the query is set to "Barcelona".\
> &#x20;       \
> \
> \### 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.\
> &#x20;   \
> \- \*\*statusCode\*\* (integer): A code representing the status of the request.\
> &#x20;   \
> \- \*\*message\*\* (string): A message providing additional context about the request's status (may be empty).\
> &#x20;   \
> \- \*\*response\*\* (array): An array containing the search results, where each result has the following properties:\
> &#x20;   \
> &#x20;   \- \*\*id\*\* (integer): A unique identifier for the football entity.\
> &#x20;       \
> &#x20;   \- \*\*name\*\* (string): The name of the football entity.\
> &#x20;       \
> &#x20;   \- \*\*nameCode\*\* (string): A code representing the name of the football entity.\
> &#x20;       \
> &#x20;   \- \*\*national\*\* (boolean): Indicates if the entity is national.\
> &#x20;       \
> &#x20;   \- \*\*type\*\* (string): The type of entity (e.g., player, team).\
> &#x20;       \
> &#x20;   \- \*\*gender\*\* (string): The gender associated with the entity.\
> &#x20;       \
> &#x20;   \- \*\*country\*\* (object): An object containing country information:\
> &#x20;       \
> &#x20;       \- \*\*alpha2\*\* (string): The two-letter country code.\
> &#x20;           \
> &#x20;       \- \*\*name\*\* (string): The name of the country.\
> &#x20;           \
> &#x20;   \- \*\*score\*\* (integer): A score associated with the search result.\
> &#x20;       \
> \
> This structure provides a comprehensive overview of the search results related to the specified query.

```json
{"openapi":"3.0.0","info":{"title":"FOOTBALL API V1","version":"1.0.0"},"tags":[],"servers":[{"url":"https://apiv3.sportsapi360.com"}],"security":[{"apikeyAuth":[]}],"components":{"securitySchemes":{"apikeyAuth":{"type":"http","scheme":"x-api-key"}}},"paths":{"/football/api/v1/global/search":{"get":{"tags":["default"],"summary":"Global Search","description":"### Endpoint Description\n\nThis 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.\n\n### Request Format\n\n- **Method**: GET\n    \n- **URL**: `https://apiv3.sportsapi360.com/football/api/v1/global/search`\n    \n- **Query Parameters**:\n    \n    - `query` (string): The search term used to find relevant football data. In this example, the query is set to \"Barcelona\".\n        \n\n### Response Structure\n\nThe response from this endpoint will be in JSON format and consists of the following structure:\n\n- **status** (boolean): Indicates whether the request was successful.\n    \n- **statusCode** (integer): A code representing the status of the request.\n    \n- **message** (string): A message providing additional context about the request's status (may be empty).\n    \n- **response** (array): An array containing the search results, where each result has the following properties:\n    \n    - **id** (integer): A unique identifier for the football entity.\n        \n    - **name** (string): The name of the football entity.\n        \n    - **nameCode** (string): A code representing the name of the football entity.\n        \n    - **national** (boolean): Indicates if the entity is national.\n        \n    - **type** (string): The type of entity (e.g., player, team).\n        \n    - **gender** (string): The gender associated with the entity.\n        \n    - **country** (object): An object containing country information:\n        \n        - **alpha2** (string): The two-letter country code.\n            \n        - **name** (string): The name of the country.\n            \n    - **score** (integer): A score associated with the search result.\n        \n\nThis structure provides a comprehensive overview of the search results related to the specified query.","parameters":[{"name":"x-api-key","in":"header","schema":{"type":"string"}},{"name":"query","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"string"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.sportsapi360.com/football-docs/api-collection-football/football-api-v1.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
