​
Overview

The EntityReferees endpoint retrieves a paginated list of referees stored in the KoraStats database. The endpoint allows filtering referees using several search criteria to narrow down results according to the needs of your application. The response includes:
  • Referee ID
  • Full name
  • Nationality
  • Date of birth
  • Calculated age
  • Gender
  • Retirement status
  • Profile image
This endpoint is commonly used for:
  • Loading referee directories
  • Synchronizing referee databases
  • Searching referees by name or nationality
  • Filtering referees who participated in specific seasons
GET /api.php

​
Parameters

​
module
string
Always use api
​
api
string
Always use EntityReferees
​
version
string
API version. Example: V2
​
response
string
Response format. Always use json
​
lang
string
Language of the response. Example: en
​
page_size
integer
Number of records returned per page.
​
page_number
integer
Page index of the results.
​
seasons
string
Comma-separated list of season identifiers to filter referees who participated in those seasons.Example:seasons=444,445
​
name
string
Search referees by name.Example:name=Ali
​
country_id
integer
Filter referees by nationality.
​
since
datetime
Returns referees updated after the specified date and time.Format:YYYY-MM-DD HH:MM:SSExample:since=2023-01-15 12:30:00

​
Date Format Requirements

The since parameter must follow the exact datetime format: YYYY-MM-DD HH:MM:SS Guidelines:
  • Year: four digits (e.g., 2023)
  • Month: two digits (01 to 12)
  • Day: two digits (01 to 31)
  • Hour: two digits (00 to 23)
  • Minutes: two digits (00 to 59)
  • Seconds: two digits (00 to 59)
Example: since=2023-01-15 12:30:00 The date and time must be provided in local server time.

​
Pagination

Pagination allows retrieving large datasets efficiently.
ParameterDescription
page_sizeNumber of referees returned in each request
page_numberSpecifies which page of results to retrieve

​
Example Request

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

{
  "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 referees matching the filters."
            },
            "current_records": {
              "type": "integer",
              "description": "Number of referees returned in this request."
            },
            "pages": {
              "type": "integer",
              "description": "Total number of available pages."
            },
            "current_page": {
              "type": "integer",
              "description": "Current page number."
            },
            "Data": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "_type": {
                    "type": "string"
                  },
                  "id": {
                    "type": "integer"
                  },
                  "fullname": {
                    "type": "string"
                  },
                  "nationality": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "integer"
                      },
                      "name": {
                        "type": "string"
                      }
                    }
                  },
                  "dob": {
                    "type": "string",
                    "nullable": true
                  },
                  "age": {
                    "type": "string",
                    "nullable": true
                  },
                  "retired": {
                    "type": "boolean"
                  },
                  "gender": {
                    "type": "string"
                  },
                  "image": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}