# README
Go API client for QRZ.com
A GoLang client library for QRZ.com's XML subscription data service. The service provides real-time access to information from the QRZ.COM servers and databases. The API is documented here.
This client library was generated based on the OpenAPI specification in
the api/openapi.yaml
file. However, the API itself is not well-described by
OpenAPI, so the generated library is supplemented with wrapper.go
.
A simple application to demonstrate how to integrate the library is located in
cmd/qrz-lookup/main.go
.
A QRZ.com XML subscription is required to take full advantage of the API. A description of subscription plans and rates is available on the QRZ.com website.
# Packages
No description provided by the author
# Functions
CacheExpires helper function to determine remaining time before repeating a request.
No description provided by the author
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResonse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewConfiguration returns a new Configuration object.
# Variables
ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKey takes an APIKey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
# Structs
APIClient manages communication with the QRZ XML Logbook Data Specification API v1.34 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
APIResponse stores the API response returned by the server.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
Callsign struct for Callsign.
Configuration stores the configuration of the API client.
Dxcc struct for Dxcc.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
QrzDatabase struct for QrzDatabase.
RootGetOpts Optional parameters for the method 'RootGet'.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
Session struct for Session.
# Type aliases
DefaultApiService DefaultApi service.