A set of REST APIs has been created to enable software applications to access the score database.
All requests are type GET and do not require authentication. They return content type application/json.
Every response includes status and status_message. Error responses also include value, the part of the request that was not accepted. The HTTP status code is the same as status:
Mode can be ph, ssb, or cw in upper or lower case. A space in a category name can be written as + (sh+all) or %20 (sh%20all).
Retrieve final score by year and mode for a callsign (entry call or in operator list).
https://cqwpx.com/api/get/<request>/<mode>/<year>/<callsign>
<request> Required. Must be "score"
<mode> Required. Must be ph, ssb, or cw
<year> Required. Between 1970 and latest results.
<callsign> Required. At least 3 characters, including any portable indicator. Matches the entry call (also with a portable indicator before or after it) or the whole callsign in the operator list, so K1AR does not match K1ART.
Examples:
https://cqwpx.com/api/get/score/ph/2020/k5zd Get score for K5ZD from 2020 Phone.
https://cqwpx.com/api/get/score/cw/1992/k5zd/3 Get score for K5ZD/3 from 1993 CW.
https://cqwpx.com/api/get/score/cw/*/k5zd Get CW scores for K5ZD for all years.
Retrieve record score for given mode, category, and region (call area, country, continent).
https://cqwpx.com/api/get/<request>/<mode>/<category>/<geo>
<request> Required. Must be "record"
<mode> Required. Must be ph, ssb, or cw
<category> Required. Category for filter. See Category List below for accepted values. Asterisk (*) can be used for wild card; the result is the single highest score across all matching categories.
<geo> Optional. Blank or "world", 3 letter continent indicator, or country prefix.
Examples:
https://cqwpx.com/api/get/record/cw/sh%20all/w1 Get record for CW, single operator, high power, all bands, for W1 area.
https://cqwpx.com/api/get/record/ph/*40*/eur Get record for SSB, all 40 meter single band categories, for Europe.
Retrieve list of available geo strings for filters and their display name. Can be world, continent, or country.
https://cqwpx.com/api/get/<request>/
<request> Required. Must be "geolist"
Example:
https://cqwpx.com/api/get/geolist Get list of all geo strings that will be accepted and their display name.
The geo list is cached and may take up to one hour to show changes after new results are loaded.
Retrieve list of available categories for filters.
https://cqwpx.com/api/get/<request>/
<request> Required. Must be "catlist"
Example:
https://cqwpx.com/api/get/catlist Get list of all category strings that will be accepted and their display name.
Retrieve list of active club names. Active clubs are those that have had 3 or more log entries within the previous 4 years.
https://cqwpx.com/api/get/<request>/
<request> Required. Must be "clublist"
Example:
https://cqwpx.com/api/get/clublist Get list of all active club names and the region where they are located.
The club list is cached and may take up to one hour to show changes after new results are loaded.
Raw scores are only available between the log deadline and the publication of final results. At other times these requests return 404 (no results found).
Retrieve list of raw scores by category.
https://cqwpx.com/api/get/<request>/<mode>/category/<categoryname>
<request> Required. Must be "raw"
<mode> Required. Must be ph, ssb, or cw
<categoryname> Required. Must be item from list of categories. Asterisk (*) can be used for wild card to get scores from all matching categories.
Example:
https://cqwpx.com/api/get/raw/ph/category/sh%20all Get list of all raw scores for single operator, all bands, high power (SH ALL).
Retrieve list of raw scores by callsign.
https://cqwpx.com/api/get/<request>/<mode>/callsign/<callsign>/
<request> Required. Must be "raw"
<mode> Required. Must be ph, ssb, or cw
<callsign> Required. Must be complete callsign (at least 3 characters) including any portables. Matched the same way as for Score above.
Example:
https://cqwpx.com/api/get/raw/ph/callsign/aa3b Get list of all raw scores where callsign is found as entry call or in list of operators. May return more than one row if multiple entries found.
All APIs are provided as is and without support.