Skip to content

brandenc40/qcmobile

Repository files navigation

FMCSA QC Mobile API Client

Go Reference Go Report Card

Unofficial API client

https://mobile.fmcsa.dot.gov/QCDevsite/home

go get github.com/brandenc40/qcmobile

Client Interface

// Client - QC Mobile API Client interface
type Client interface {
    SearchCarriersByName(ctx context.Context, name string, start, size int) ([]*CarrierDetails, error)
    GetCompleteCarrierDetails(ctx context.Context, dotNumber string) (*CompleteCarrierDetails, error)
    GetCarriersByDocket(ctx context.Context, docketNumber string) ([]*CarrierDetails, error)
    GetCarrier(ctx context.Context, dotNumber string) (*CarrierDetails, error)
    GetCargoCarried(ctx context.Context, dotNumber string) ([]*CargoClass, error)
    GetOperationClassification(ctx context.Context, dotNumber string) ([]*OperationClass, error)
    GetDocketNumbers(ctx context.Context, dotNumber string) ([]*Docket, error)
    GetAuthority(ctx context.Context, dotNumber string) ([]*AuthorityDetails, error)
    GetOOS(ctx context.Context, dotNumber string) ([]*OOSDetails, error)
    GetBasics(ctx context.Context, dotNumber string) ([]*BasicsDetails, error)
}

Example Usage

package main

import (
	"context"
	"fmt"
	"net/http"
	"time"

	"github.com/brandenc40/qcmobile"
)

func main() {
	// build client
	cfg := qcmobile.Config{
		Key:        "YOUR_KEY",
		HTTPClient: &http.Client{}, // OPTIONAL - will default to &http.Client{} if nil
	}
	client := qcmobile.NewClient(cfg)
	
	// build context to handle function timeout
	ctx, cancel := context.WithTimeout(context.Background(), 2*time.Second)
	defer cancel()
	
	// get carrier from QC Mobile and print
	carrier, err := client.GetCarrier(ctx, "53467")
	if err != nil {
		// handle error
	}
	fmt.Println(carrier.Carrier)
}