Data Types¶
Note
If an attribute of any class is unknown or not included from that data source, it will be None
or a similar enum value.
Callsign Data¶
- class callsignlookuptools.CallsignData(query, raw_data, data_source, type=None, callsign=None, aliases=None, trustee=None, lic_class=None, lic_codes=None, effective_date=None, expire_date=None, last_action_date=None, prev_call=None, prev_lic_class=None, modified_date=None, name=None, address=None, dxcc=None, dxcc_prefix=None, qth=None, continent=None, latlong=None, grid=None, county=None, district=None, oblast=None, dok=None, sondok=None, plot=None, fips=None, msa=None, area_code=None, cq_zone=None, itu_zone=None, iota=None, geoloc_src=None, timezone=None, qsl=None, born=None, licensed=None, email=None, username=None, url=None, page_views=None, db_serial=None, bio=None, image=None, social_media=None, uls_url=None, frn=None)¶
Represents the data for a callsign retrieved from a lookup service
- query: str¶
the callsign searched for
- raw_data: pydantic.main.BaseModel¶
the raw data, as parsed by pydantic from the API response. Probably not needed for most use cases.
- data_source: callsignlookuptools.common.enums.DataSource¶
the lookup service the data comes from
- type: Optional[callsignlookuptools.common.enums.CallsignType] = None¶
the type of license the callsign is associated with
- callsign: Optional[str] = None¶
the callsign, as received from the lookup service. Not always the same as the query.
- aliases: Optional[list] = None¶
alias callsigns
- trustee: Optional[callsignlookuptools.common.dataclasses.Trustee] = None¶
trustee info
- lic_class: Optional[Union[str, callsignlookuptools.common.enums.LicenseClass]] = None¶
license class. Some lookup services have a defined set of classes.
- lic_codes: Optional[str] = None¶
license codes
- effective_date: Optional[datetime.datetime] = None¶
license effective/grant date
- expire_date: Optional[datetime.datetime] = None¶
license expiration date
- last_action_date: Optional[datetime.datetime] = None¶
license last updated date
- prev_call: Optional[str] = None¶
previous callsign
- prev_lic_class: Optional[callsignlookuptools.common.enums.LicenseClass] = None¶
previous license class
- modified_date: Optional[datetime.datetime] = None¶
lookup service record modification date
- name: Optional[callsignlookuptools.common.dataclasses.Name] = None¶
licensee name
- address: Optional[callsignlookuptools.common.dataclasses.Address] = None¶
licensee address
- dxcc: Optional[callsignlookuptools.common.dataclasses.Dxcc] = None¶
licensee DXCC entity
- dxcc_prefix: Optional[str] = None¶
licensee DXCC’s primary callsign prefix
- qth: Optional[str] = None¶
licensee location
- continent: Optional[callsignlookuptools.common.enums.Continent] = None¶
licensee continent
- latlong: Optional[gridtools.gridtools.LatLong] = None¶
latitude and longitude of address or QTH
- grid: Optional[gridtools.gridtools.Grid] = None¶
grid square locator of address or QTH
- county: Optional[str] = None¶
county of address or QTH
- district: Optional[str] = None¶
district of address or QTH
- oblast: Optional[str] = None¶
oblast of address or QTH (Russia only)
- dok: Optional[str] = None¶
DOK name (Germany only)
- sondok: Optional[bool] = None¶
whether the DOK is a Sonder-DOK (Germany only)
- plot: Optional[str] = None¶
Polish OT number (Poland only)
- fips: Optional[str] = None¶
Federal Information Processing Standards number (USA only)
- msa: Optional[str] = None¶
Metro Service Area (USA only)
- area_code: Optional[str] = None¶
telephone area code (USA only)
- cq_zone: Optional[int] = None¶
CQ zone
- itu_zone: Optional[int] = None¶
ITU zone
- iota: Optional[str] = None¶
Islands on the Air designator
- geoloc_src: Optional[callsignlookuptools.common.enums.GeoLocSource] = None¶
geolocation information source
- timezone: Optional[callsignlookuptools.common.dataclasses.Timezone] = None¶
licensee time zone
- qsl: Optional[callsignlookuptools.common.dataclasses.Qsl] = None¶
QSL info
- born: Optional[int] = None¶
year born
- licensed: Optional[int] = None¶
year licensed
- email: Optional[str] = None¶
licensee email address
- username: Optional[str] = None¶
username of license page manager
- url: Optional[str] = None¶
url of the webpage for the callsign
- page_views: Optional[int] = None¶
callsign page views
- db_serial: Optional[str] = None¶
QRZ database serial number
- bio: Optional[callsignlookuptools.common.dataclasses.Bio] = None¶
biography info
- image: Optional[callsignlookuptools.common.dataclasses.Image] = None¶
profile image info
- social_media: Optional[callsignlookuptools.common.dataclasses.SocialMedia] = None¶
social media info
- uls_url: Optional[str] = None¶
ULS record url (USA only)
- frn: Optional[str] = None¶
FRN (USA only)
Exceptions¶
- class callsignlookuptools.CallsignLookupError(*args)¶
The exception raised when something goes wrong in callsignlookuptools
Helper Data Types¶
- class callsignlookuptools.common.dataclasses.Dxcc(id=None, name=None)¶
Represents a DXCC entity
- id: Optional[int] = None¶
entity ID
- name: Optional[str] = None¶
entity name
- class callsignlookuptools.common.dataclasses.Address(attn=None, line1=None, line2=None, line3=None, city=None, state=None, zip=None, country=None, country_code=None)¶
Represents a mailing address
- attn: Optional[str] = None¶
Attention address line, this line should be prepended to the address
- line1: Optional[str] = None¶
address line 1
- line2: Optional[str] = None¶
address line 2
- line3: Optional[str] = None¶
address line 3
- city: Optional[str] = None¶
city
- state(USA Only): Optional[str] = None¶
state (USA Only)
- zip: Optional[str] = None¶
Zip/postal code
- country: Optional[str] = None¶
country name for the QSL mailing address
- country_code: Optional[int] = None¶
dxcc entity code for the mailing address country
- class callsignlookuptools.common.dataclasses.Name(first=None, name=None, nickname=None, formatted_name=None)¶
Represents a name
- first: Optional[str] = None¶
first name(s)
- name: Optional[str] = None¶
last name or full name
- nickname: Optional[str] = None¶
A different or shortened name used on the air
- formatted_name: Optional[str] = None¶
Combined full name and nickname in the format used by QRZ. This format is subject to change.
- class callsignlookuptools.common.dataclasses.Trustee(callsign=None, name=None)¶
Represents a club callsign trustee (USA only)
- callsign: Optional[str] = None¶
trustee callsign
- name: Optional[str] = None¶
trustee name
- class callsignlookuptools.common.dataclasses.Qsl(info=None, bureau_info=None, eqsl=<QslStatus.UNKNOWN: None>, lotw=<QslStatus.UNKNOWN: None>, mail=<QslStatus.UNKNOWN: None>, bureau=<QslStatus.UNKNOWN: None>)¶
Represents information about QSL methods
- info: Optional[str] = None¶
info about QSLing, e.g. QSL manager info
- bureau_info: Optional[str] = None¶
info about QSLing via bureau
- eqsl: callsignlookuptools.common.enums.QslStatus = None¶
whether eQSL is accepted
- lotw: callsignlookuptools.common.enums.QslStatus = None¶
whether Logbook of the World QSL is accepted
- mail: callsignlookuptools.common.enums.QslStatus = None¶
whether direct mail QSL is accepted
- bureau: callsignlookuptools.common.enums.QslStatus = None¶
whether bureau QSL is accepted
- class callsignlookuptools.common.dataclasses.Bio(size=None, updated=None)¶
Represents metadata for a QRZ bio
- size: Optional[int] = None¶
approximate size in bytes
- updated: Optional[datetime.datetime] = None¶
when the bio was last updated
- class callsignlookuptools.common.dataclasses.Image(url=None, size=None, height=None, width=None)¶
Represents an image
- url: Optional[str] = None¶
image url
- size: Optional[int] = None¶
image size in bytes
- height: Optional[int] = None¶
image height in pixels
- width: Optional[int] = None¶
image width in pixels
- class callsignlookuptools.common.dataclasses.SocialMedia(website=None, jabber=None, icq=None, msn=None, skype=None, facebook=None, twitter=None, google_plus=None, youtube=None, linkedin=None, flickr=None, vimeo=None)¶
represents social media info
- website: Optional[str] = None¶
website url
- jabber: Optional[str] = None¶
Jabber username
- icq: Optional[str] = None¶
ICQ number
- msn: Optional[str] = None¶
MSN username
- skype: Optional[str] = None¶
Skype username
- facebook: Optional[str] = None¶
Facebook profile url
- twitter: Optional[str] = None¶
Twitter profile url
- google_plus: Optional[str] = None¶
Google+ profile url
- youtube: Optional[str] = None¶
YouTube channel url
- linkedin: Optional[str] = None¶
LinkedIn profile url
- flickr: Optional[str] = None¶
Flickr profile url
- vimeo: Optional[str] = None¶
Vimeo profile url
- class callsignlookuptools.common.dataclasses.Timezone(utc_offset=None, us_timezone=None, observes_dst=None)¶
Timezone(utc_offset: Optional[str] = None, us_timezone: Optional[str] = None, observes_dst: Optional[bool] = None)
Enums¶
- enum callsignlookuptools.common.enums.DataSource(value)¶
Describes the callsign data lookup source
Valid values are as follows:
- CALLOOK¶
- HAMQTH¶
- QRZ¶
- QRZCQ¶
- enum callsignlookuptools.common.enums.Continent(value)¶
Represents a continent
Valid values are as follows:
- AF¶
- AN¶
- AS¶
- EU¶
- NA¶
- OC¶
- SA¶
- NONE¶
- enum callsignlookuptools.common.enums.CallsignType(value)¶
Describes what kind of license the license holder has
Valid values are as follows:
- CLUB¶
- MILITARY¶
- RACES¶
- RECREATION¶
- PERSON¶
- NONE¶
- enum callsignlookuptools.common.enums.LicenseClass(value)¶
Describes the class of a license
Valid values are as follows:
- NOVICE¶
- TECHNICIAN¶
- TECHNICIAN_PLUS¶
- GENERAL¶
- ADVANCED¶
- EXTRA¶
- NONE¶