​
Overview

The EntityClubs endpoint returns a paginated list of clubs stored in the KoraStats database. The endpoint supports search filters, pagination, and incremental synchronization using the since parameter. Each club record may include:
  • Club identity
  • Country information
  • National federation indicator
  • Club logo
  • Associated teams
Each team object may include:
  • Team name
  • Stadium
  • Coach
  • Gender category
  • National team indicator
  • Team image

​
Typical use cases

  • Build searchable club databases
  • Synchronize club data with external systems
  • Retrieve club lists for competitions
  • Load paginated club lists in dashboards
GET /api.php

​
Parameters

​
module
string
Always use api
​
api
string
Always use EntityClubs
​
version
string
API version. Example: V2
​
response
string
Response format. Always use json
​
lang
string
Language of the response. Example: en
​
national_federation
boolean
Filter by national federation status.1 → National federations
0 → Clubs
​
country_id
integer
Filter clubs by country.
​
name
string
Search clubs by name. Partial matches are supported.
​
since
datetime
Returns clubs updated after the specified date and time.Format: YYYY-MM-DD HH:MM:SS
​
page_size
integer
Number of clubs returned per page.
​
page_number
integer
Page number of the results to retrieve.

​
Since Parameter

The since parameter enables incremental synchronization. Only clubs updated after the provided timestamp will be returned. Format: YYYY-MM-DD HH:MM:SS Example: since=2023-01-15 12:30:00 Date components:
ComponentFormatExample
Year4 digits2024
Month2 digits01–12
Day2 digits01–31
Hour2 digits00–23
Minutes2 digits00–59
Seconds2 digits00–59

​
Pagination

The endpoint supports standard pagination.
ParameterDescription
page_sizeNumber of records returned per request
page_numberPage index of the results
Example: page_size=100 page_number=1

​
Example Request

curl --request GET \
  --url "https://korastats.pro/pro/api.php?module=api&api=EntityClubs&version=V2&response=json&lang=en&page_size=100&page_number=1"

{
  "type": "object",
  "properties": {
    "root": {
      "type": "object",
      "properties": {
        "result": {
          "type": "boolean"
        },
        "title": {
          "type": "string"
        },
        "message": {
          "type": "string"
        },
        "object": {
          "type": "object",
          "properties": {
            "total_records": {
              "type": "integer",
              "description": "Total number of clubs matching the query."
            },
            "current_records": {
              "type": "integer",
              "description": "Number of clubs returned in this page."
            },
            "pages": {
              "type": "integer",
              "description": "Total number of pages available."
            },
            "current_page": {
              "type": "integer",
              "description": "Current page number."
            },
            "Data": {
              "type": "array",
              "description": "List of clubs",
              "items": {
                "type": "object",
                "properties": {
                  "_type": {
                    "type": "string"
                  },
                  "id": {
                    "type": "integer"
                  },
                  "name": {
                    "type": "string"
                  },
                  "country": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "integer"
                      },
                      "name": {
                        "type": "string"
                      }
                    }
                  },
                  "national_federation": {
                    "type": "boolean"
                  },
                  "logo": {
                    "type": "string"
                  },
                  "teams": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "_type": {
                          "type": "string"
                        },
                        "id": {
                          "type": "integer"
                        },
                        "name": {
                          "type": "string"
                        },
                        "stadium": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "integer"
                            },
                            "name": {
                              "type": "string"
                            }
                          }
                        },
                        "coach": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "integer"
                            },
                            "name": {
                              "type": "string"
                            }
                          }
                        },
                        "gender": {
                          "type": "string"
                        },
                        "is_national_team": {
                          "type": "boolean"
                        },
                        "image": {
                          "type": "string"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}