QRZCQ for Developers

XML API for call lookups (auth, read-only) <- THIS IS THE ONLY OFFICIAL SUPPORTED API

JSON API for common data (open, read-only) <- BETA, COULD WORK BUT ALSO COULD CHANGE EVERYDAY

JSON API for account data (auth, read-write) <- ALPHA, PLEASE USE AT YOU OWN RISK

### UPLOAD your logbook to QRZCQ ***

Assume your call is AAA, your API-Key is BBB, your logbook in
ADIF, post a json encoded object to this URL:


  https://ssl.qrzcq.com/api/logupload


Request:

stdClass Object
(
    [auth] => stdClass Object
        (
            [call] => AAA
            [key] => BBB
        )

    [data] => stdClass Object
        (
            [adif] => (json encoded adif)
        )

)


A response could be:

stdClass Object
(
    [status] => OK
    [message] => DATA_QUEUED
    [request] => stdClass Object
        (
            [method] => logupload
            [opt1] => 
            [opt2] => 
            [opt3] => 
            [postdata] => stdClass Object
                (
                    [auth] => stdClass Object
                        (
                            [call] => AAA
                            [key] => ********
                        )

                )

        )

    [cpu] => 0.003
)


You should post no more than 1x per minute.

### GET your rig status from QRZCQ ###

Poll the following URL via POST to know if you have to set your rig.

Assume your call is AAA and your API-Key is BBB post a json encoded
object to this URL to get your data to set the rig to:


  https://ssl.qrzcq.com/api/rig/get


Request:

stdClass Object
(
    [auth] => stdClass Object
        (
            [call] => AAA
            [key] => BBB
        )

)


A response could be:

stdClass Object
(
    [rig] => stdClass Object
        (
            [set] => stdClass Object
                (
                    [freq] => 21311000
                    [mode] => USB
                    [date] => 2016-03-30 00:30:45
                )

        )

    [status] => OK
    [request] => stdClass Object
        (
            [method] => rig
            [opt1] => get
            [opt2] => 
            [opt3] => 
            [request] => stdClass Object
                (
                    [auth] => stdClass Object
                        (
                            [call] => AAA
                            [key] => BBB
                        )

                )

        )

    [cpu] => 0.003
)


This means you should set your rig to 21311000 Hz USB.

You should poll no more than 2x per second.

### PUT your rig status to QRZCQ ***

Assume your call is AAA, your API-Key is BBB, your mode is LSB and
your frequency is 3.795 MHz, post a json encoded object to this URL:


  https://ssl.qrzcq.com/api/rig/put


Request:

stdClass Object
(
    [auth] => stdClass Object
        (
            [call] => AAA
            [key] => BBB
        )

    [request] => stdClass Object
        (
            [mode] => LSB
            [freq] => 3795000
            [smeter] => 47
        )

)

mode = LSB,USB,FM,AM,DIGI,RTTY,PSK31 etc.
freq = your frequency in Hz
smeter = your smeter in dB above S0 ( so S3 = 18, S9 = 54, S9+20 = 74 )


A response could be:

stdClass Object
(
    [status] => OK
    [request] => stdClass Object
        (
            [method] => rig
            [opt1] => put
            [opt2] => 
            [opt3] => 
            [request] => stdClass Object
                (
                    [auth] => stdClass Object
                        (
                            [call] => AAA
                            [key] => BBB
                        )

                    [request] => stdClass Object
                        (
                            [mode] => LSB
                            [freq] => 3795000
                            [smeter] => 47
                        )

                )

        )

    [cpu] => 0.004
)

You should post no more than 1x per second.