API Documentation

Comprehensive guide to integrating with the killboard API.

Submit a New Kill

This endpoint allows authorized clients to submit details about a kill event to the database.

Endpoint: /api/v1/kills

Method: POST

Authentication: Requires a valid Bearer token in the Authorization header. The API key can be found on your Profile page after you've verified your account via RSI.

Request Headers

Header	Value	Required	Description
`Authorization`	`Bearer <api-key>`	Yes	The API key for authentication.
`Content-Type`	`application/json`	Yes	Specifies the format of the request body.
`Accept`	`application/json`	Yes	Indicates the client accepts a JSON response.

Request Body Parameters

Parameter	Type	Required	Validation Rules
`username`	String	Yes	`required`, `string`, `exists:users,username`
`timestamp`	String	Yes	`required`, `string`, `date_format:Y-m-d\TH:i:s.u\Z`
`kill_type`	String	Yes	`required`, `string`, `min:2`, Must be one of: `vehicle`, `fps`
`location`	String	Yes	`required`, `string`, `min:4`
`killer`	String	Yes	`required`, `string`, `min:3`
`victim`	String	Yes	`required`, `string`, `min:3`
`weapon`	String	Yes	`required`, `string`, `min:3`
`vehicle`	String	No	`sometimes`, `string`, `min:4`

Please note: The killer, victim and vehicle fields will undergo additional validation via RSI.

Example Request Body

        {
            "username": "discord_username",
            "timestamp": "2025-10-23T10:30:00.123456Z",
            "kill_type": "vehicle",
            "location": "OOC_Stanton_3a",
            "killer": "ENIGM4",
            "victim": "Carebear_69420",
            "weapon": "MXOX_Neutronrepeater_S3",
            "vehicle": "DRAK_Corsair"
        }

Response Codes

201 Created: The kill event was successfully recorded.
401 Unauthorized: The Authorization header is missing or the API Key is invalid.
422 Unprocessable Entity: Validation failed for one or more input parameters. The response body will contain specific error messages.
500 Internal Server Error: An unexpected server error occurred.