Club API
Club records officers can use this API to retrieve records from their Club members. Note that for this to happen three things must be in place:
- You will need an API Key, which can be obtained by contacting us, using the email link in the page footer. We need to know who you are, your position in the club, and the exact club name
- Each club member must have the club name configured in their settings - EXACTLY as the one used with the API key. e.g. 'Overton Black Arrows' is not the same as 'Overton black arrows'
- Users need to be opted into allowing their data to be obtained this way. The latest version of ExpertArcher has a setting for this, by default this in 'on'
API basics
The API can be called using the URL: https://fapi.expertarcher.com/club?apikey=(key)&club=(clubname) This will return ALL scores for all members of your club, in JSON format. Please do not do this without thought - there can be a lot of records returned.
The following additional parameters can be added to reduce the number of records:
- &from=(date), e.g. from=2022-01-27 to retrieve all records on and including the 27th Jan 22
- &to=(date), e.g. to=2022-03-20 to retrieve all records before and including the 20th Mar 22
- &round=(round), e.g. round=Portsmouth to retrieve all Portsmouth rounds.
- &gender=male|female
- &class=Master|senior|U18|U16|U15|U14|U13|U12|U11
- &bowtype=recurve|barebow|longbow|compound|compound limited|compound barebow|AFB|horsebow|traditional|instinctive
- &location=indoor|outdoor
The following parameter can be used to control the output fields:
- &select=field1,field2 e.g. select=hits,golds,score will only produce those three fields (in addition to date, round, name - which are always returned)
Records are sorted by date by default, newest first to change this, use:
- &sort=(field);asc|desc - e.g. sort=round or sort=score;asc or score (desc is the default, if left off)
Finally, the type of output can be determined by:
- &view=html|csv - without this parameter, JSON will be returned
Example
To get an HTML table containing all Portsmouth rounds shot in February, please note that the example will only work with a correct club name and API key!!
https://fapi.expertarcher.com/club?apikey=3fde14b7779658bb3a8dd2e2084ff961&club=My Club&round=Portsmouth&from=2022-02-01&to=2022-02-28&view=html
Example Output
...yes, I can get good scores, but that pesky Richard Buckner....
Notes
- This is experimental at the moment!
- You need to keep your API key secret!