Statistics API

The endpoint for the statistics API is: /citydriving/stats

API Index

We currently offer the following statistics APIs:

API	Documentation
Users Online	View Docs
Gumball	View Docs
Top Distance	View Docs
Top Money	View Docs
Top Wealth	View Docs
Cop Experience	View Docs
Robber Experience	View Docs
Roleplay Points	View Docs
Last Tickets	View Docs
Top Crashers	View Docs
Newest Players	View Docs
Badges & Licenses	View Docs
[TC] Training Team Members	View Docs
[TC] CityDriving Members	View Docs
[TC] CityDriving Admins by Level	View Docs
[TC] Racing Members	View Docs
[TC] Gaming Members	View Docs

API-Wide Optional Parameters

All statistics API requests default to 20 rows of returned data. Certain applications may require more rows or a range of rows. For this reason all statistics API requests can utilise the rows and skip parameters. With these parameters, you can request any range of rows in the top 1000 total records.

Name	Expected Value	Default Value
rows	{integer} : Number of rows to request: 1-1000	20
skip	{integer} : Number of rows to skip/offset: 1-1000	-
prettyprint	{integer} : Use pretty print: 0 | 1	-

Examples

Request first 50 records: rows=50 Request records 60 to 80: skip=60 Request records 100 to 200: skip=100&rows=100

Users Online

The users online API gives you basic details of all users who are online on a [TC] CityDriving server.

ENDPOINT: /citydriving/stats/online

Mandatory Parameters

Name	Expected Value
key	{string} : API Key
server	{string}: one | two | three | all

Optional Parameters

See API-Wide Optional Parameters.

Example

REQUEST: ?key=YOUR_KEY&server=all

This request usually returns all connected users on a given CityDriving server. This example only shows one user for brevity. The default range is 20 users.

RESPONSE:

GET https://api.tc-gaming.co.uk/citydriving/stats/online?key=YOUR_KEY&server=all
HTTP/1.1 200 OK

[
    {
        "id": 11969,
        "countryCode": "GB",
        "username": "Garypants",
        "nickname": "^1[TC]^7\u203aCarl\u2039",
        "money": 259473,
        "distance": 156889746,
        "trip": 34846,
        "bonus": 22,
        "lastCar": "XRT",
        "lastPosition": "^3Medical Centre^8",
        "server": "^7One"
    },
    ...
]

Gumball

The Gumball API gives you access to a separate table comprising entries into the current Gumball event. Records are ordered by a user's position in the overall Gumball standings. This API will return an empty array if the event is not currently running.

ENDPOINT: /citydriving/stats/gumball

Mandatory Parameters

Name	Expected Value
key	{string} : API Key

Optional Parameters

See API-Wide Optional Parameters.

Example

REQUEST: ?key=YOUR_KEY

This request returns all users currently entered into a Gumball event. This example only shows one user for brevity. The default range is 20 users.

RESPONSE:

GET https://api.tc-gaming.co.uk/citydriving/stats/gumball?key=YOUR_KEY
HTTP/1.1 200 OK

[
    {
        "id": 17,
        "countryCode": "GB",
        "username": "mbutcher",
        "nickname": "^1[TC]\u00bbPete\u00ab",
        "start_distance": 226358557.0859,
        "start_time": 20416734,
        "current_time": 20416734,
        "current_distance": 226358557.0859,
        "gumball_distance": 0,
        "gumball_time": 0,
        "avg_speed": 0,
        "last_seen_ago": 927539,
        "server": "^7One"
    },
    ...
]

Top Distance

The top distance API can return any range of the top 1000 users with the highest total driven distance. The default range is 20.

ENDPOINT: /citydriving/stats/distance

Mandatory Parameters

Name	Expected Value
key	{string} : API Key

Optional Parameters

See API-Wide Optional Parameters.

Example

REQUEST: ?key=YOUR_KEY

This request usually returns all connected users on all CityDriving servers. This example only shows one user for brevity.

RESPONSE:

GET https://api.tc-gaming.co.uk/citydriving/stats/online?key=YOUR_KEY
HTTP/1.1 200 OK

[
    {
        "id": 23210,
        "countrycode": "HU",
        "username": "sergey29",
        "nickname": "^2[GLOW]Angel[COP]",
        "value": 341002806.665
    },
    ...
]

Top Money

The top money API can return any range of the top 1000 users with the most money. The default range is 20.

ENDPOINT: /citydriving/stats/money

Mandatory Parameters

Name	Expected Value
key	{string} : API Key

Optional Parameters

See API-Wide Optional Parameters.

Example

REQUEST: ?key=YOUR_KEY

This example only shows one user for brevity.

RESPONSE:

GET https://api.tc-gaming.co.uk/citydriving/stats/money?key=YOUR_KEY
HTTP/1.1 200 OK

[
    {
        "id": 2107,
        "countrycode": "DE",
        "username": "P V L",
        "nickname": "^7Just ^1P ^7V ^1L",
        "money": 4671440
    },
    ...
]

Top Wealth

The top wealth API can return any range of the top 1000 users with the most money and assets (wealth). The default range is 20.

ENDPOINT: /citydriving/stats/wealth

Mandatory Parameters

Name	Expected Value
key	{string} : API Key

Optional Parameters

See API-Wide Optional Parameters.

Example

REQUEST: ?key=YOUR_KEY

This example only shows one user for brevity.

RESPONSE:

GET https://api.tc-gaming.co.uk/citydriving/stats/wealth?key=YOUR_KEY
HTTP/1.1 200 OK

[
    {
        "id": 2107,
        "countryCode": "DE",
        "username": "P V L",
        "nickname": "^7Just ^1P ^7V ^1L",       
        "wealth": 5249230,
    },
    ...
]

Cop Experience

The cop experience API can return any range of the top 1000 users with the highest cop experience. The default range is 20.

ENDPOINT: /citydriving/stats/cop_xp

Mandatory Parameters

Name	Expected Value
key	{string} : API Key

Optional Parameters

See API-Wide Optional Parameters.

Example

REQUEST: ?key=YOUR_KEY

This example only shows one user for brevity.

RESPONSE:

GET https://api.tc-gaming.co.uk/citydriving/stats/cop_xp?key=YOUR_KEY
HTTP/1.1 200 OK

[
    {
        "id": 23210,
        "countrycode": "HU",
        "username": "sergey29",
        "nickname": "^2[GLOW]Angel[COP]",
        "value": 485492
    },
    ...
]

Robber Experience

The robber experience API can return any range of the top 1000 users with the highest robber experience. The default range is 20.

ENDPOINT: /citydriving/stats/robber_xp

Mandatory Parameters

Name	Expected Value
key	{string} : API Key

Optional Parameters

See API-Wide Optional Parameters.

Example

REQUEST: ?key=YOUR_KEY

This example only shows one user for brevity.

RESPONSE:

GET https://api.tc-gaming.co.uk/citydriving/stats/robber_xp?key=YOUR_KEY
HTTP/1.1 200 OK

[
    {
        "id": 23210,
        "countryCode": "HU",
        "username": "sergey29",
        "nickname": "^2[GLOW]Angel[COP]",
        "xp": 150961,
        "lastSeen": "2017-08-26 20:15:17",
        "server": "^7Two"
    },
    ...
]

Roleplay Points

The roleplay points API can return any range of the top 1000 users with the highest number of roleplaying points (RP). The default range is 20.

ENDPOINT: /citydriving/stats/rp

Mandatory Parameters

Name	Expected Value
key	{string} : API Key

Optional Parameters

See API-Wide Optional Parameters.

Example

REQUEST: ?key=YOUR_KEY

This example only shows one user for brevity.

RESPONSE:

GET https://api.tc-gaming.co.uk/citydriving/stats/rp?key=YOUR_KEY
HTTP/1.1 200 OK

[
    {
        "id": 23210,
        "countrycode": "HU",
        "username": "sergey29",
        "nickname": "^2[GLOW]Angel[COP]",
        "value": 152305
    },
    ...
]

Last Tickets

The last tickets API can return any range of the latest 1000 issued fines. The default range is 20.

ENDPOINT: /citydriving/stats/last_tickets

Mandatory Parameters

Name	Expected Value
key	{string} : API Key

Optional Parameters

See API-Wide Optional Parameters.

Example

REQUEST: ?key=YOUR_KEY

This example only shows one ticket for brevity.

RESPONSE:

GET https://api.tc-gaming.co.uk/citydriving/stats/last_tickets?key=YOUR_KEY
HTTP/1.1 200 OK

[
    {
        "id_cop": 29920,
        "username_cop": "adwin",
        "cop": "^6[G27]^5Milo^6[COP]",
        "id_robber": 30308,
        "username_robber": "emogss",
        "robber": "^1\u00d0^0' Kirito \u672b",
        "date": 1504023566,
        "location": "^3Gas Station^8, Weston Park",
        "offense": "Wrong side \/ wrong way",
        "fine": 50
    },
    ...
]

Top Crashers

The top crashers API can return any range of the top 1000 with the most 'heavy contacts'. The default range is 20.

ENDPOINT: /citydriving/stats/crashers

Mandatory Parameters

Name	Expected Value
key	{string} : API Key

Optional Parameters

See API-Wide Optional Parameters.

Example

REQUEST: ?key=YOUR_KEY

This example only shows one user for brevity.

RESPONSE:

GET https://api.tc-gaming.co.uk/citydriving/stats/crashers?key=YOUR_KEY
HTTP/1.1 200 OK

[
    {
        "id": 23210,
        "countrycode": "HU",
        "username": "sergey29",
        "nickname": "^2[GLOW]Angel[COP]",
        "value": 6459
    },
    ...
]

Newest Players

The newest players API can return any range of the newest 1000 players. The default range is 20.

ENDPOINT: /citydriving/stats/new_players

Mandatory Parameters

Name	Expected Value
key	{string} : API Key

Optional Parameters

See API-Wide Optional Parameters.

Example

REQUEST: ?key=YOUR_KEY

This example only shows one user for brevity.

RESPONSE:

GET https://api.tc-gaming.co.uk/citydriving/stats/new_players?key=YOUR_KEY
HTTP/1.1 200 OK

[
    {
        "id": 30917,
        "countryCode": "GB",
        "username": "matthew997",
        "nickname": "matthew997",
        "money": 2045,
        "dateJoined": 1504012848,
        "distance": 91926.6326
    },
    ...
]

Badges & Licenses

Get all users who have a certain license. The default range is 20.

ENDPOINT: /citydriving/stats/badge

Mandatory Parameters

Name	Expected Value
key	{string} : API Key
badge	{string} : Badge Name (See list of values below)

Optional Parameters

See API-Wide Optional Parameters.

List of Badges & Licenses

These are the most common values for badge.

Name	Value Code
COP	cop
TOW	tow
MED/RES	med
RACE	race
[TC] CityDriving Admin	tc
[TC] CityDriving Recruit	recruit
[TC] Trainer	tct
[CSR] Member	csr
6Speed Member	6s
[RDSR] Member	rdsr
SO Member	so

Example

REQUEST: ?key=YOUR_KEY&badge=cop

This example lists COP badges and only shows one user for brevity.

RESPONSE:

GET https://api.tc-gaming.co.uk/citydriving/stats/badge?key=YOUR_KEY&badge=cop
HTTP/1.1 200 OK

[
    {
        "id": 4,
        "countrycode": "DE",
        "username": "chucknorris",
        "nickname": "^7\u2039Chuck\u203a"
    },
    ...
]

[TC] Training Team Members

Get a list of training team members. The default range is 20 so you may need to use a higher value for the rows parameter.

ENDPOINT: /citydriving/stats/trainer_level

Mandatory Parameters

Name	Expected Value
key	{string} : API Key

Optional Parameters

See API-Wide Optional Parameters.

Trainer Levels

The levels key refers to a trainer's basic rank within the team:

Rank	Level
Leader	1
Trainer	2
Assistant	3
Civillian Assistant	4

Example

REQUEST: ?key=YOUR_KEY

This example only shows one user for brevity.

RESPONSE:

GET https://api.tc-gaming.co.uk/citydriving/stats/trainer_level?key=YOUR_KEY
HTTP/1.1 200 OK

[
    {
        "id": 487,
        "countrycode": "GB",
        "username": "Degats",
        "nickname": "^1[TC]\u00bbElmo\u00ab[HwA]",
        "trainer_level": 1
    },
    ...
]

[TC] CityDriving Members

Get a list of [TC] CityDriving admins. The default range is 20 so you may need to use a higher value for the rows parameter.

ENDPOINT: /citydriving/stats/tcmembers

Mandatory Parameters

Name	Expected Value
key	{string} : API Key

Optional Parameters

See API-Wide Optional Parameters.

Example

REQUEST: ?key=YOUR_KEY

This example only shows one user for brevity.

RESPONSE:

GET https://api.tc-gaming.co.uk/citydriving/stats/tcmembers?key=YOUR_KEY
HTTP/1.1 200 OK

[
    {
        "id": 17,
        "countryCode": "GB",
        "username": "mbutcher",
        "nickname": "^1[TC]\u00bbPete\u00ab",
        "lastSeen": 1502325692,
        "adminLevel": 1
    },
    ...
]

[TC] CityDriving Admins by Level

Get a list of [TC] CityDriving admins by their admin level. The default range is 20 so you may need to use a higher value for the rows parameter.

ENDPOINT: /citydriving/stats/admins

Mandatory Parameters

Name	Expected Value
key	{string} : API Key
level	{string} : Admin Level (See list of values below)

Optional Parameters

See API-Wide Optional Parameters.

Admin Levels

The levels key refers to an admin's basic rank within the team. Use the following levels as values for the level parameter:

Rank	Level
Leader/Server Control/Chief Constable/CCiT	1
Inspector/Supervisor	2
Constable	3
Constable in Probation	4

Example

REQUEST: ?key=YOUR_KEY

This example only shows one user for brevity.

RESPONSE:

GET https://api.tc-gaming.co.uk/citydriving/stats/admins?key=YOUR_KEY&level=1
HTTP/1.1 200 OK

[
    {
        "id": 17,
        "countryCode": "GB",
        "username": "mbutcher",
        "nickname": "^1[TC]\u00bbPete\u00ab",
        "lastSeen": 1502325692,
        "adminLevel": 1
    },
    ...
]

[TC] Racing Members

Get a list of [TC] Racing members. The default range is 20 so you may need to use a higher value for the rows parameter.

ENDPOINT: /citydriving/stats/tcrmembers

Mandatory Parameters

Name	Expected Value
key	{string} : API Key

Optional Parameters

See API-Wide Optional Parameters.

Admin Levels

The levels key refers to an admin's basic rank within the team.

Rank	Level
[TC] Team Leader/[TC] Racing Manager	1
[TC] Racing Driver	2

Example

REQUEST: ?key=YOUR_KEY

This example only shows one user for brevity.

RESPONSE:

GET https://api.tc-gaming.co.uk/citydriving/stats/tcrmembers?key=YOUR_KEY
HTTP/1.1 200 OK

[
    {
        "id": 17,
        "countryCode": "GB",
        "username": "mbutcher",
        "nickname": "^1[TC]\u00bbPete\u00ab",
        "lastSeen": 1502325692,
        "adminLevel": 1
    },
    ...
]

[TC] Gaming Members

Get a list of [TC] Gaming members. Note that the returned list currently only includes members who have been explicitly given a [TC] Gaming admin level and not those who have inherited [TC] Gaming membership by being a full member of [TC] CityDriving or [TC] Racing. The default range is 20 so you may need to use a higher value for the rows parameter.

ENDPOINT: /citydriving/stats/tcgmembers

Mandatory Parameters

Name	Expected Value
key	{string} : API Key

Optional Parameters

See API-Wide Optional Parameters.

Admin Levels

The levels key refers to an admin's basic rank within the team.

Rank	Level
[TC] Team Leader	1
[TC] Gaming Member	2

Example

REQUEST: ?key=YOUR_KEY

This example only shows one user for brevity.

RESPONSE:

GET https://api.tc-gaming.co.uk/citydriving/stats/tcgmembers?key=YOUR_KEY
HTTP/1.1 200 OK

[
    {
        "id": 17,
        "countryCode": "GB",
        "username": "mbutcher",
        "nickname": "^1[TC]\u00bbPete\u00ab",
        "lastSeen": 1502325692,
        "adminLevel": 1
    },
    ...
]