API Reference¶
QRZ¶
- class callsignlookuptools.QrzSyncClient(username, password, session_key='', useragent='python-callsignlookuptools-v1.0.1', session=None)¶
Synchronous QRZ API client
- Parameters
username (
str
) – QRZ usernamepassword (
str
) – QRZ passwordsession_key (
str
) – QRZ login session keyuseragent (
str
) – Useragent for QRZsession (
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
- Returns
the callsign data from the lookup service
- Raises
common.exceptions.CallsignLookupError
on network or parsing error
- property password: str¶
- Getter
gets password
- Setter
sets password
- Return type
str
- property session: requests.Session¶
- Getter
gets the requests session
- Setter
sets the requests session
- Return type
Session
- property session_key: str¶
- Getter
gets API session key
- Setter
sets API session key
- Return type
str
- property useragent: str¶
- Getter
gets useragent
- Setter
sets useragent
- Return type
str
- property username: str¶
- Getter
gets username
- Setter
sets username
- Return type
str
- class callsignlookuptools.QrzAsyncClient(username, password, session_key='', useragent='python-callsignlookuptools-v1.0.1', session=None)¶
Asynchronous QRZ API client
- Parameters
username (
str
) – QRZ usernamepassword (
str
) – QRZ passwordsession_key (
str
) – QRZ login session keyuseragent (
str
) – Useragent for QRZsession (
Optional
[ClientSession
]) – An aiohttp session to use for requests
- async classmethod new(username, password, session_key='', useragent='python-callsignlookuptools-v1.0.1', session=None)¶
Creates a
QrzAsyncClient
object and automatically starts a session if not provided.- Parameters
username (
str
) – QRZ usernamepassword (
str
) – QRZ passwordsession_key (
str
) – QRZ login session keyuseragent (
str
) – Useragent for QRZsession (
Optional
[ClientSession
]) – An aiohttp session to use for requests
- Return type
- async search(callsign)¶
Search for a callsign
- Parameters
callsign (
str
) – the callsign to look up- Return type
- 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: str¶
- Getter
gets password
- Setter
sets password
- Return type
str
- property session: Optional[aiohttp.client.ClientSession]¶
- Getter
gets the aiohttp session
- Setter
sets the aiohttp session
- Return type
Optional
[ClientSession
]
- property session_key: str¶
- Getter
gets API session key
- Setter
sets API session key
- Return type
str
- async start_session()¶
Creates a new
aiohttp.ClientSession
- property useragent: str¶
- Getter
gets useragent
- Setter
sets useragent
- Return type
str
- property username: str¶
- Getter
gets username
- Setter
sets username
- Return type
str
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
- Returns
the callsign data from the lookup service
- Raises
common.exceptions.CallsignLookupError
on network or parsing error
- property session: requests.Session¶
- Getter
gets the requests session
- Setter
sets the requests session
- Return type
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
- async search(callsign)¶
Search for a callsign
- Parameters
callsign (
str
) – the callsign to look up- Return type
- 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: Optional[aiohttp.client.ClientSession]¶
- Getter
gets the aiohttp session
- Setter
sets the aiohttp session
- Return type
Optional
[ClientSession
]
- async start_session()¶
Creates a new
aiohttp.ClientSession
HamQTH¶
- class callsignlookuptools.HamQthSyncClient(username, password, session_key='', useragent='python-callsignlookuptools-v1.0.1', session=None)¶
Synchronous HamQTH API client
- Parameters
username (
str
) – HamQTH usernamepassword (
str
) – HamQTH passwordsession_key (
str
) – HamQTH login session keyuseragent (
str
) – Useragent for HamQTHsession (
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
- Returns
the callsign data from the lookup service
- Raises
common.exceptions.CallsignLookupError
on network or parsing error
- property password: str¶
- Getter
gets password
- Setter
sets password
- Return type
str
- property session: requests.Session¶
- Getter
gets the requests session
- Setter
sets the requests session
- Return type
Session
- property session_key: str¶
- Getter
gets API session key
- Setter
sets API session key
- Return type
str
- property useragent: str¶
- Getter
gets useragent
- Setter
sets useragent
- Return type
str
- property username: str¶
- Getter
gets username
- Setter
sets username
- Return type
str
- class callsignlookuptools.HamQthAsyncClient(username, password, session_key='', useragent='python-callsignlookuptools-v1.0.1', session=None)¶
Asynchronous HamQTH API client
- Parameters
username (
str
) – HamQTH usernamepassword (
str
) – HamQTH passwordsession_key (
str
) – HamQTH login session keyuseragent (
str
) – Useragent for HamQTHsession (
Optional
[ClientSession
]) – An aiohttp session to use for requests
- async classmethod new(username, password, session_key='', useragent='python-callsignlookuptools-v1.0.1', session=None)¶
Creates a
HamQthAsyncClient
object and automatically starts a session if not provided.- Parameters
username (
str
) – HamQTH usernamepassword (
str
) – HamQTH passwordsession_key (
str
) – HamQTH login session keyuseragent (
str
) – Useragent for HamQTHsession (
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
- 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: str¶
- Getter
gets password
- Setter
sets password
- Return type
str
- property session: Optional[aiohttp.client.ClientSession]¶
- Getter
gets the aiohttp session
- Setter
sets the aiohttp session
- Return type
Optional
[ClientSession
]
- property session_key: str¶
- Getter
gets API session key
- Setter
sets API session key
- Return type
str
- async start_session()¶
Creates a new
aiohttp.ClientSession
- property useragent: str¶
- Getter
gets useragent
- Setter
sets useragent
- Return type
str
- property username: str¶
- Getter
gets username
- Setter
sets username
- Return type
str
QRZCQ¶
- class callsignlookuptools.QrzCqSyncClient(username, password, session_key='', useragent='python-callsignlookuptools-v1.0.1', session=None)¶
Synchronous QRZCQ API client
- Parameters
username (
str
) – QRZCQ usernamepassword (
str
) – QRZCQ passwordsession_key (
str
) – QRZCQ login session keyuseragent (
str
) – Useragent for QRZCQsession (
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
- Returns
the callsign data from the lookup service
- Raises
common.exceptions.CallsignLookupError
on network or parsing error
- property password: str¶
- Getter
gets password
- Setter
sets password
- Return type
str
- property session: requests.Session¶
- Getter
gets the requests session
- Setter
sets the requests session
- Return type
Session
- property session_key: str¶
- Getter
gets API session key
- Setter
sets API session key
- Return type
str
- property useragent: str¶
- Getter
gets useragent
- Setter
sets useragent
- Return type
str
- property username: str¶
- Getter
gets username
- Setter
sets username
- Return type
str
- class callsignlookuptools.QrzCqAsyncClient(username, password, session_key='', useragent='python-callsignlookuptools-v1.0.1', session=None)¶
Asynchronous QRZCQ API client
- Parameters
username (
str
) – QRZCQ usernamepassword (
str
) – QRZCQ passwordsession_key (
str
) – QRZCQ login session keyuseragent (
str
) – Useragent for QRZCQsession (
Optional
[ClientSession
]) – An aiohttp session to use for requests
- async classmethod new(username, password, session_key='', useragent='python-callsignlookuptools-v1.0.1', session=None)¶
Creates a
QrzCqAsyncClient
object and automatically starts a session if not provided.- Parameters
username (
str
) – QRZCQ usernamepassword (
str
) – QRZCQ passwordsession_key (
str
) – QRZCQ login session keyuseragent (
str
) – Useragent for QRZCQsession (
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
- 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: str¶
- Getter
gets password
- Setter
sets password
- Return type
str
- property session: Optional[aiohttp.client.ClientSession]¶
- Getter
gets the aiohttp session
- Setter
sets the aiohttp session
- Return type
Optional
[ClientSession
]
- property session_key: str¶
- Getter
gets API session key
- Setter
sets API session key
- Return type
str
- async start_session()¶
Creates a new
aiohttp.ClientSession
- property useragent: str¶
- Getter
gets useragent
- Setter
sets useragent
- Return type
str
- property username: str¶
- Getter
gets username
- Setter
sets username
- Return type
str