API Reference

QRZ

class callsignlookuptools.QrzSyncClient(username, password, session_key='', useragent='python-callsignlookuptools-v1.1.1', session=None)

Synchronous QRZ API client

Parameters:
  • username (str) – QRZ username

  • password (str) – QRZ password

  • session_key (str) – QRZ login session key

  • useragent (str) – Useragent for QRZ

  • session (Optional[Session]) – A requests session to use for requests

search(callsign)

Search for a callsign

Parameters:

callsign (str) – the callsign to look up

Return type:

CallsignData

Returns:

the callsign data from the lookup service

Raises:

common.exceptions.CallsignLookupError on network or parsing error

property password
Getter:

gets password

Setter:

sets password

property session
Getter:

gets the requests session

Setter:

sets the requests session

property session_key
Getter:

gets API session key

Setter:

sets API session key

property useragent
Getter:

gets useragent

Setter:

sets useragent

property username
Getter:

gets username

Setter:

sets username

class callsignlookuptools.QrzAsyncClient(username, password, session_key='', useragent='python-callsignlookuptools-v1.1.1', session=None)

Asynchronous QRZ API client

Parameters:
  • username (str) – QRZ username

  • password (str) – QRZ password

  • session_key (str) – QRZ login session key

  • useragent (str) – Useragent for QRZ

  • session (Optional[ClientSession]) – An aiohttp session to use for requests

async classmethod new(username, password, session_key='', useragent='python-callsignlookuptools-v1.1.1', session=None)

Creates a QrzAsyncClient object and automatically starts a session if not provided.

Parameters:
  • username (str) – QRZ username

  • password (str) – QRZ password

  • session_key (str) – QRZ login session key

  • useragent (str) – Useragent for QRZ

  • session (Optional[ClientSession]) – An aiohttp session to use for requests

Return type:

QrzAsyncClient

async search(callsign)

Search for a callsign

Parameters:

callsign (str) – the callsign to look up

Return type:

CallsignData

Returns:

the callsign data from the lookup service

Raises:

common.exceptions.CallsignLookupError on network or parsing error

async close_session()

Closes the aiohttp.ClientSession session

property password
Getter:

gets password

Setter:

sets password

property session
Getter:

gets the aiohttp session

Setter:

sets the aiohttp session

property session_key
Getter:

gets API session key

Setter:

sets API session key

async start_session()

Creates a new aiohttp.ClientSession

property useragent
Getter:

gets useragent

Setter:

sets useragent

property username
Getter:

gets username

Setter:

sets username

Callook

class callsignlookuptools.CallookSyncClient(session=None)

Synchronous Callook API client

Parameters:

session (Optional[Session]) – A requests session to use for requests

search(callsign)

Search for a callsign

Parameters:

callsign (str) – the callsign to look up

Return type:

CallsignData

Returns:

the callsign data from the lookup service

Raises:

common.exceptions.CallsignLookupError on network or parsing error

property session
Getter:

gets the requests session

Setter:

sets the requests session

class callsignlookuptools.CallookAsyncClient(session=None)

Asynchronous Callook API client

Parameters:

session (Optional[ClientSession]) – An aiohttp session to use for requests

async classmethod new(session=None)

Creates a CallookAsyncClient object and automatically starts a session if not provided.

Parameters:

session (Optional[ClientSession]) – An aiohttp session to use for requests

Return type:

CallookAsyncClient

async search(callsign)

Search for a callsign

Parameters:

callsign (str) – the callsign to look up

Return type:

CallsignData

Returns:

the callsign data from the lookup service

Raises:

common.exceptions.CallsignLookupError on network or parsing error

async close_session()

Closes the aiohttp.ClientSession session

property session
Getter:

gets the aiohttp session

Setter:

sets the aiohttp session

async start_session()

Creates a new aiohttp.ClientSession

HamQTH

class callsignlookuptools.HamQthSyncClient(username, password, session_key='', useragent='python-callsignlookuptools-v1.1.1', session=None)

Synchronous HamQTH API client

Parameters:
  • username (str) – HamQTH username

  • password (str) – HamQTH password

  • session_key (str) – HamQTH login session key

  • useragent (str) – Useragent for HamQTH

  • session (Optional[Session]) – A requests session to use for requests

search(callsign)

Search for a callsign

Parameters:

callsign (str) – the callsign to look up

Return type:

CallsignData

Returns:

the callsign data from the lookup service

Raises:

common.exceptions.CallsignLookupError on network or parsing error

property password
Getter:

gets password

Setter:

sets password

property session
Getter:

gets the requests session

Setter:

sets the requests session

property session_key
Getter:

gets API session key

Setter:

sets API session key

property useragent
Getter:

gets useragent

Setter:

sets useragent

property username
Getter:

gets username

Setter:

sets username

class callsignlookuptools.HamQthAsyncClient(username, password, session_key='', useragent='python-callsignlookuptools-v1.1.1', session=None)

Asynchronous HamQTH API client

Parameters:
  • username (str) – HamQTH username

  • password (str) – HamQTH password

  • session_key (str) – HamQTH login session key

  • useragent (str) – Useragent for HamQTH

  • session (Optional[ClientSession]) – An aiohttp session to use for requests

async classmethod new(username, password, session_key='', useragent='python-callsignlookuptools-v1.1.1', session=None)

Creates a HamQthAsyncClient object and automatically starts a session if not provided.

Parameters:
  • username (str) – HamQTH username

  • password (str) – HamQTH password

  • session_key (str) – HamQTH login session key

  • useragent (str) – Useragent for HamQTH

  • session (Optional[ClientSession]) – An aiohttp session to use for requests

async search(callsign)

Search for a callsign

Parameters:

callsign (str) – the callsign to look up

Return type:

CallsignData

Returns:

the callsign data from the lookup service

Raises:

common.exceptions.CallsignLookupError on network or parsing error

async close_session()

Closes the aiohttp.ClientSession session

property password
Getter:

gets password

Setter:

sets password

property session
Getter:

gets the aiohttp session

Setter:

sets the aiohttp session

property session_key
Getter:

gets API session key

Setter:

sets API session key

async start_session()

Creates a new aiohttp.ClientSession

property useragent
Getter:

gets useragent

Setter:

sets useragent

property username
Getter:

gets username

Setter:

sets username

QRZCQ

class callsignlookuptools.QrzCqSyncClient(username, password, session_key='', useragent='python-callsignlookuptools-v1.1.1', session=None)

Synchronous QRZCQ API client

Parameters:
  • username (str) – QRZCQ username

  • password (str) – QRZCQ password

  • session_key (str) – QRZCQ login session key

  • useragent (str) – Useragent for QRZCQ

  • session (Optional[Session]) – A requests session to use for requests

search(callsign)

Search for a callsign

Parameters:

callsign (str) – the callsign to look up

Return type:

CallsignData

Returns:

the callsign data from the lookup service

Raises:

common.exceptions.CallsignLookupError on network or parsing error

property password
Getter:

gets password

Setter:

sets password

property session
Getter:

gets the requests session

Setter:

sets the requests session

property session_key
Getter:

gets API session key

Setter:

sets API session key

property useragent
Getter:

gets useragent

Setter:

sets useragent

property username
Getter:

gets username

Setter:

sets username

class callsignlookuptools.QrzCqAsyncClient(username, password, session_key='', useragent='python-callsignlookuptools-v1.1.1', session=None)

Asynchronous QRZCQ API client

Parameters:
  • username (str) – QRZCQ username

  • password (str) – QRZCQ password

  • session_key (str) – QRZCQ login session key

  • useragent (str) – Useragent for QRZCQ

  • session (Optional[ClientSession]) – An aiohttp session to use for requests

async classmethod new(username, password, session_key='', useragent='python-callsignlookuptools-v1.1.1', session=None)

Creates a QrzCqAsyncClient object and automatically starts a session if not provided.

Parameters:
  • username (str) – QRZCQ username

  • password (str) – QRZCQ password

  • session_key (str) – QRZCQ login session key

  • useragent (str) – Useragent for QRZCQ

  • session (Optional[ClientSession]) – An aiohttp session to use for requests

async search(callsign)

Search for a callsign

Parameters:

callsign (str) – the callsign to look up

Return type:

CallsignData

Returns:

the callsign data from the lookup service

Raises:

common.exceptions.CallsignLookupError on network or parsing error

async close_session()

Closes the aiohttp.ClientSession session

property password
Getter:

gets password

Setter:

sets password

property session
Getter:

gets the aiohttp session

Setter:

sets the aiohttp session

property session_key
Getter:

gets API session key

Setter:

sets API session key

async start_session()

Creates a new aiohttp.ClientSession

property useragent
Getter:

gets useragent

Setter:

sets useragent

property username
Getter:

gets username

Setter:

sets username