Events Validation¶

These resources are used by Match Macro-Events and Match Micro-Events resources to cross-reference static data related to match events at micro- and macro-scale.

Positions¶

GET /v1/positions/(int: ID)¶

Returns the names of field positions in a football match.

If ID is passed, return data for the position the ID corresponds to.

If query parameters are passed, it returns the record that matches the specified filters.

Warning

This resource cannot be paginated. Any requests with records or page parameters will return a 400 BAD REQUEST error.

Query and Response Parameters:

Field	Type	Description
name	string	Name of field position.

Link Parameters:

Field	URL Description
players	Players resource representations of same position.

Example:

GET /v1/positions/21 HTTP/1.1
Host: api-connect.soccermetrics.net
Accept: application/json

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Server: gunicorn/18.0
Date: Thu, 24 Jul 2014 05:37:29 GMT
Connection: close
Content-Type: application/json
Content-Length: 597

{
  "attribution": {
    "html": "<a href=\"http://www.soccermetrics.net\"><img src=\"http://soccermetrics-connect-v1.s3.amazonaws.com/logo/soccermetrics_logo.png\"/></a>",
    "logo": "http://soccermetrics-connect-v1.s3.amazonaws.com/logo/soccermetrics_logo.png",
    "source": {},
    "text": "Powered by Soccermetrics Research",
    "url": "http://www.soccermetrics.net"
  },
  "meta": {},
  "result": [
    {
      "id": 21,
      "link": {
        "players": "/v1/personnel/players?position=21"
      },
      "name": "Central Midfielder",
      "uri": "/v1/positions/21"
    }
  ]
}

OPTIONS /v1/positions¶: Returns documentation of the positions resource.

Fouls¶

GET /v1/fouls/(int: ID)¶

Returns the descriptions of fouling actions in a football match.

If ID is passed, return data for the foul the ID corresponds to.

If query parameters are passed, it returns the record that matches the specified filters.

Warning

This resource cannot be paginated. Any requests with records or page parameters will return a 400 BAD REQUEST error.

Query and Response Parameters:

Field	Type	Description
desc	string	Description of foul.

Example:

GET /v1/fouls/22 HTTP/1.1
Host: api-connect.soccermetrics.net
Accept: application/json

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Server: gunicorn/18.0
Date: Thu, 24 Jul 2014 05:40:49 GMT
Connection: close
Content-Type: application/json
Content-Length: 534

{
  "attribution": {
    "html": "<a href=\"http://www.soccermetrics.net\"><img src=\"http://soccermetrics-connect-v1.s3.amazonaws.com/logo/soccermetrics_logo.png\"/></a>",
    "logo": "http://soccermetrics-connect-v1.s3.amazonaws.com/logo/soccermetrics_logo.png",
    "source": {},
    "text": "Powered by Soccermetrics Research",
    "url": "http://www.soccermetrics.net"
  },
  "meta": {},
  "result": [
    {
      "desc": "Deadball encroachment",
      "id": 22,
      "link": {},
      "uri": "/v1/fouls/22"
    }
  ]
}

OPTIONS /v1/fouls¶: Returns documentation of the fouls resource.

Cards¶

GET /v1/cards/(int: ID)¶

Returns the descriptions of disciplinary cards shown in a football match.

If ID is passed, return data for the card the ID corresponds to.

If query parameters are passed, it returns the record that matches the specified filters.

Warning

This resource cannot be paginated. Any requests with records or page parameters will return a 400 BAD REQUEST error.

Query and Response Parameters:

Field	Type	Description
desc	string	Type of disciplinary card.

Example:

GET /v1/cards HTTP/1.1
Host: api-connect.soccermetrics.net
Accept: application/json

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Server: gunicorn/18.0
Date: Thu, 24 Jul 2014 05:42:05 GMT
Connection: close
Content-Type: application/json
Content-Length: 720

{
  "attribution": {
    "html": "<a href=\"http://www.soccermetrics.net\"><img src=\"http://soccermetrics-connect-v1.s3.amazonaws.com/logo/soccermetrics_logo.png\"/></a>",
    "logo": "http://soccermetrics-connect-v1.s3.amazonaws.com/logo/soccermetrics_logo.png",
    "source": {},
    "text": "Powered by Soccermetrics Research",
    "url": "http://www.soccermetrics.net"
  },
  "meta": {},
  "result": [
    {
      "desc": "Yellow",
      "id": 1,
      "link": {},
      "uri": "/v1/cards/1"
    },
    {
      "desc": "Yellow/Red",
      "id": 2,
      "link": {},
      "uri": "/v1/cards/2"
    },
    {
      "desc": "Red",
      "id": 3,
      "link": {},
      "uri": "/v1/cards/3"
    }
  ]
}

OPTIONS /v1/cards¶: Returns documentation of the cards resource.

Body Parts¶

GET /v1/bodyparts/(int: ID)¶

Returns the descriptions of body parts used in a football match.

If ID is passed, return data for the body part the ID corresponds to.

If query parameters are passed, it returns the record that matches the specified filters.

Warning

This resource cannot be paginated. Any requests with records or page parameters will return a 400 BAD REQUEST error.

Query and Response Parameters:

Field	Type	Description
desc	string	Name of bodypart.

Example:

GET /v1/bodyparts/4 HTTP/1.1
Host: api-connect.soccermetrics.net
Accept: application/json

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Server: gunicorn/18.0
Date: Thu, 24 Jul 2014 05:43:39 GMT
Connection: close
Content-Type: application/json
Content-Length: 525

{
  "attribution": {
    "html": "<a href=\"http://www.soccermetrics.net\"><img src=\"http://soccermetrics-connect-v1.s3.amazonaws.com/logo/soccermetrics_logo.png\"/></a>",
    "logo": "http://soccermetrics-connect-v1.s3.amazonaws.com/logo/soccermetrics_logo.png",
    "source": {},
    "text": "Powered by Soccermetrics Research",
    "url": "http://www.soccermetrics.net"
  },
  "meta": {},
  "result": [
    {
      "desc": "Right Foot",
      "id": 4,
      "link": {},
      "uri": "/v1/bodyparts/4"
    }
  ]
}

OPTIONS /v1/bodyparts¶: Returns documentation of the bodypart resource.

Shot Events¶

GET /v1/shotevents/(int: ID)¶

Returns the descriptions of scenarios and events in which a shot was taken in a football match.

If ID is passed, return data for the shot event the ID corresponds to.

If query parameters are passed, it returns the record that matches the specified filters.

Warning

This resource cannot be paginated. Any requests with records or page parameters will return a 400 BAD REQUEST error.

Query and Response Parameters:

Field	Type	Description
desc	string	Description of shot event.

Example:

GET /v1/shotevents/12 HTTP/1.1
Host: api-connect.soccermetrics.net
Accept: application/json

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Server: gunicorn/18.0
Date: Thu, 24 Jul 2014 05:50:48 GMT
Connection: close
Content-Type: application/json
Content-Length: 540

{
  "attribution": {
    "html": "<a href=\"http://www.soccermetrics.net\"><img src=\"http://soccermetrics-connect-v1.s3.amazonaws.com/logo/soccermetrics_logo.png\"/></a>",
    "logo": "http://soccermetrics-connect-v1.s3.amazonaws.com/logo/soccermetrics_logo.png",
    "source": {},
    "text": "Powered by Soccermetrics Research",
    "url": "http://www.soccermetrics.net"
  },
  "meta": {},
  "result": [
    {
      "desc": "Cross from corner kick",
      "id": 12,
      "link": {},
      "uri": "/v1/shotevents/12"
    }
  ]
}

OPTIONS /v1/shotevents¶: Returns documentation of the shot event resource.

Penalty Outcomes¶

GET /v1/penalty_outcomes/(int: ID)¶

Returns the descriptions of penalty kick outcomes in a football match.

If ID is passed, return data for the outcome the ID corresponds to.

If query parameters are passed, it returns the record that matches the specified filters.

Warning

This resource cannot be paginated. Any requests with records or page parameters will return a 400 BAD REQUEST error.

Query and Response Parameters:

Field	Type	Description
desc	string	Description of penalty outcome.

Example:

GET /v1/penalty_outcomes/4 HTTP/1.1
Host: api-connect.soccermetrics.net
Accept: application/json

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Server: gunicorn/18.0
Date: Thu, 24 Jul 2014 05:53:27 GMT
Connection: close
Content-Type: application/json
Content-Length: 534

{
  "attribution": {
    "html": "<a href=\"http://www.soccermetrics.net\"><img src=\"http://soccermetrics-connect-v1.s3.amazonaws.com/logo/soccermetrics_logo.png\"/></a>",
    "logo": "http://soccermetrics-connect-v1.s3.amazonaws.com/logo/soccermetrics_logo.png",
    "source": {},
    "text": "Powered by Soccermetrics Research",
    "url": "http://www.soccermetrics.net"
  },
  "meta": {},
  "result": [
    {
      "desc": "Wide of post",
      "id": 4,
      "link": {},
      "uri": "/v1/penalty_outcomes/4"
    }
  ]
}

OPTIONS /v1/penalty_outcomes¶: Returns documentation of the penalty outcome resource.

Event Actions¶

GET /v1/actions/(int: ID)¶

Returns the descriptions of event actions in a football match. If ID is passed, return data for the outcome the ID corresponds to.

If query parameters are passed, it returns the record that matches the specified filters.

Query and Response Parameters:

Field	Type	Description
desc	string	Description of match event.

Example:

GET /v1/actions?records=5&page=3 HTTP/1.1
Host: api-connect.soccermetrics.net
Accept: application/json

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Server: gunicorn/18.0
Date: Thu, 24 Jul 2014 06:09:18 GMT
Connection: close
Content-Type: application/json
Content-Length: 1211

{
  "attribution": {
    "html": "<a href=\"http://www.soccermetrics.net\"><img src=\"http://soccermetrics-connect-v1.s3.amazonaws.com/logo/soccermetrics_logo.png\"/></a>",
    "logo": "http://soccermetrics-connect-v1.s3.amazonaws.com/logo/soccermetrics_logo.png",
    "source": {},
    "text": "Powered by Soccermetrics Research",
    "url": "http://www.soccermetrics.net"
  },
  "meta": {
    "first": "/v1/actions?records=5&page=1",
    "last": "/v1/actions?records=5&page=5",
    "next": "/v1/actions?records=5&page=4",
    "page": 3,
    "prev": "/v1/actions?records=5&page=2",
    "records": 5,
    "totalPages": 5,
    "totalRecords": 24
  },
  "result": [
    {
      "desc": "Penalty",
      "id": 110,
      "link": {},
      "uri": "/v1/actions/110"
    },
    {
      "desc": "Offside",
      "id": 111,
      "link": {},
      "uri": "/v1/actions/111"
    },
    {
      "desc": "Save",
      "id": 112,
      "link": {},
      "uri": "/v1/actions/112"
    },
    {
      "desc": "Foul",
      "id": 113,
      "link": {},
      "uri": "/v1/actions/113"
    },
    {
      "desc": "Card",
      "id": 114,
      "link": {},
      "uri": "/v1/actions/114"
    }
  ]
}

OPTIONS /v1/actions¶: Returns documentation of the event action resource.

Action Modifiers¶

GET /v1/modifiers/(int: ID)¶

Returns the descriptions of modifiers to event actions in a football match.

If ID is passed, return data for the outcome the ID corresponds to.

If query parameters are passed, it returns the record that matches the specified filters.

Query and Response Parameters:

Field	Type	Description
desc	string	Description of event modifier.
category	integer	Unique ID of modifier category.

Example:

GET /v1/modifiers/107 HTTP/1.1
Host: api-connect.soccermetrics.net
Accept: application/json

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Server: gunicorn/18.0
Date: Thu, 24 Jul 2014 06:07:37 GMT
Connection: close
Content-Type: application/json
Content-Length: 777

{
  "attribution": {
    "html": "<a href=\"http://www.soccermetrics.net\"><img src=\"http://soccermetrics-connect-v1.s3.amazonaws.com/logo/soccermetrics_logo.png\"/></a>",
    "logo": "http://soccermetrics-connect-v1.s3.amazonaws.com/logo/soccermetrics_logo.png",
    "source": {},
    "text": "Powered by Soccermetrics Research",
    "url": "http://www.soccermetrics.net"
  },
  "meta": {
    "first": "/v1/modifiers/107?records=10&page=1",
    "last": "/v1/modifiers/107?records=10&page=1",
    "next": null,
    "page": 1,
    "prev": null,
    "records": 10,
    "totalPages": 1,
    "totalRecords": 1
  },
  "result": [
    {
      "category": 10,
      "desc": "Clearance",
      "id": 107,
      "link": {},
      "uri": "/v1/modifiers/107"
    }
  ]
}

OPTIONS /v1/modifiers¶: Returns documentation of the event modifier resource.

Action Modifier Categories¶

GET /v1/modifier_categories/(int: ID)¶

Returns the categories of modifiers related to player actions.

If ID is passed, return data for the outcome the ID corresponds to.

If query parameters are passed, it returns the record that matches the specified filters.

Query and Response Parameters:

Field	Type	Description
desc	string	Description of category.

Example:

GET /v1/modifier_categories/15 HTTP/1.1
Host: api-connect.soccermetrics.net
Accept: application/json

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Server: gunicorn/18.0
Date: Thu, 24 Jul 2014 06:20:07 GMT
Connection: close
Content-Type: application/json
Content-Length: 539

{
  "attribution": {
    "html": "<a href=\"http://www.soccermetrics.net\"><img src=\"http://soccermetrics-connect-v1.s3.amazonaws.com/logo/soccermetrics_logo.png\"/></a>",
    "logo": "http://soccermetrics-connect-v1.s3.amazonaws.com/logo/soccermetrics_logo.png",
    "source": {},
    "text": "Powered by Soccermetrics Research",
    "url": "http://www.soccermetrics.net"
  },
  "meta": {},
  "result": [
    {
      "desc": "Field Sector",
      "id": 15,
      "link": {},
      "uri": "/v1/modifier_categories/15"
    }
  ]
}

OPTIONS /v1/modifier_categories¶: Returns documentation of the modifier category resource.