Clashfinder API

Authentication

API calls now require authentication.

Each API call must include at least two variables in the query string:

authUsername - this is the username of your clashfinder account. You must have an account to access the API. If you don't have one, you can create one here:

authPublicKey - this is a code generated by taking an sha256 hash of your username, private key and some optional parameters (see below). Your account password does not affect the public key.

API calls can have optional parameters. These parameters are encoded in the publicKey, so a public key is only valid for a specific set of parameters.

authParam (optional, letters, numbers, hyphens and underscores only) - An additional parameter to include in the hash. For example, if you wish to provide API calls for different people, set this to their name and they will receive unique public keys.

authValidUntil (optional, yyyymmddhhmmss) - A date and time that the public key will expire. If a full date-time is not provided, the string will be read left-to-right. For example, "201202" will be interpreted as 2012-02-01 00:00:00. Dates and times are UTC.

Specifying a clashfinder

The name (id) of a clashfinder can be found in its URL, between 'https://clashfinder.com/s/' and the next '/'

The name 'test' has been used in the examples on this page. To make them specific to a clashfinder, paste its URL here:

---

Data formats

Data format is specified through the file extension.

ICS (.ics)

Excel (.xlsx)

Comma separated values (.csv)

Tab separated values (.tsv.txt)

JSON (.json)

XML (.xml)

PHP array format (.php). Note: does not output executable PHP files

---

User highlights

To pull only the highlighted acts for a user, use the "user=" key

To pull specific highlights for a user, add the "hls=" key

---

Clashfinder lists

Pull a list of all core clashfinders

Pull a list of all clashfinders