Data API endpoints

Last updated 2 months ago

Endpoint to get all countries

get

Authorizations

Query parameters

locales[]string[]Optional

Locales used to translate the current entity. Using the Locale HTTP header should be preferred. The HTTP header version is used in priority if it is given

Default: ["en"]

details[]string · enum[]Optional

Header parameters

localestring · jsonOptional

Locales used to translate the current entity (json array). If this HTTP header is not given or if it is an empty array, the query parameter locales will be used

Example: [ "fr_FR","en_US" ]

Responses

application/json

objectOptional

get

GET /data/1.0.0/countries HTTP/1.1
Host: api-public.socios.com
Accept: */*

200

Successfully get countries

{
  "data": [
    {
      "id": "d36fe9b1-b524-4c82-a691-7b89cda36b4a",
      "name": "France",
      "iso2": "FR",
      "iso3": "FRA"
    }
  ]
}

Endpoint to get all partner and fan token information

get

Authorizations

Query parameters

countries[]string[]OptionalDefault: []

currencyIds[]string[]OptionalDefault: []

Responses

application/json

objectOptional

application/json

get

GET /data/1.0.0/fantokens HTTP/1.1
Host: api-public.socios.com
Accept: */*

{
  "data": [
    {
      "partnerId": "d36fe9b1-b524-4c82-a691-7b89cda36b4a",
      "partnerName": "Team Vitality",
      "partnerShortName": "TV",
      "currencyId": "d36fe9b1-b524-4c82-a691-7b89cda36b4a",
      "tokenSymbol": "EUR",
      "mainColour": "FFFFFF",
      "country": "Malta",
      "images": [
        {
          "url": "https://url.com/partner/d66eb9d2-56c6-4b1b-8f56-31f8aa319abe/partner_logo/38aca876-86a8-4a10-a0e8-b0859614c8b3.png?version=1653577420",
          "type": "png",
          "format": "desktop",
          "width": "500",
          "height": "500"
        }
      ]
    }
  ]
}

Endpoint to get all partner and fan token information

get

Authorizations

Query parameters

currencyIds[]string[]OptionalDefault: []

Responses

application/json

objectOptional

application/json

get

GET /data/1.0.0/fantokens/rate HTTP/1.1
Host: api-public.socios.com
Accept: */*

{
  "data": [
    {
      "id": "b1181a62-9fd0-4290-ac29-32318bab3bab",
      "shortCode": "JUV",
      "conversionRates": {
        "EUR": "0.802418",
        "USD": "1.015128",
        "CHZ": "13.303533",
        "BRL": "18.234673",
        "GBP": "22.103536",
        "TRY": "17.1232497"
      }
    }
  ]
}

Endpoint to get the list of all available sports

get

Authorizations

Query parameters

pageinteger · integerOptional

limitinteger · integerOptional

orderBystring · enumOptionalAvailable options:

cursorstringOptional

directionstring · enumOptionalAvailable options:

paginationModestring · enumOptionalAvailable options:

ids[]string[]OptionalDefault: []

namesstringOptional

eventTypesstringOptional

locales[]string[]OptionalDefault: []

Responses

application/json

all ofOptional

get

GET /data/1.0.0/sports HTTP/1.1
Host: api-public.socios.com
Accept: */*

200

Successfully retrieved list of sports

{
  "data": [
    {
      "id": "d36fe9b1-b524-4c82-a691-7b89cda36b4a",
      "name": "Sport name",
      "eventType": "match"
    }
  ],
  "metadata": {
    "total_items": 588,
    "current_page": 2,
    "last_page": 4,
    "cursor": "text"
  }
}

Endpoint to get the list of all available leagues

get

Authorizations

Query parameters

status[]string · enum[]Optional

Optional filter on league status

Example: created

details[]string · enum[]Optional

flag to indicate if we need to include extra details

limitintegerOptional

Maximum number of returned records

Default: 1000

orderBystringOptional

Field on which the records will be ordered

directionstring · enumOptional

Sorting order

Available options:

locales[]string[]Optional

Locales used to translate the current entity. Using the Locale HTTP header should be preferred. The HTTP header version is used in priority if it is given

Default: ["en"]

namestringOptional

sports[]string[]OptionalDefault: []

leagueCountryIso2CodesstringOptional

leagueCountryIso3CodesstringOptional

Header parameters

localestring · jsonOptional

Locales used to translate the current entity (json array). If this HTTP header is not given or if it is an empty array, the query parameter locales will be used

Example: [ "fr_FR","en_US" ]

Responses

application/json

all ofOptional

get

GET /data/1.0.0/leagues HTTP/1.1
Host: api-public.socios.com
Accept: */*

200

Successfully retrieved list of leagues

{
  "data": [
    {
      "id": "d36fe9b1-b524-4c82-a691-7b89cda36b4a",
      "name": "League name",
      "description": "Short description",
      "sportId": "d36fe9b1-b524-4c82-a691-7b89cda36b4a",
      "partnerIds": [
        "d36fe9b1-b524-4c82-a691-7b89cda36b4a"
      ],
      "countryISO2": "IT",
      "countryISO3": "ITA",
      "status": "active"
    }
  ]
}