North Carolina DOT

Fetching data from North Carolina DOT with Airbyte and Python.


This Airbyte Connector uses the HTTP API provided by the North Carolina DOT in Python. With this connector, data is easily pulled from North Carolina DOT and loaded into the ViaWarn Postgres database, and are available in the ViaWarn app.

The connector is built on top of the Airbyte open-source platform, which provides a standardized way of integrating data sources and destinations. It is designed to be simple and easy to use. The required configuration is show in the the sections below. 

The pulled resource from the NC 511 API is the following:

Requirements and Installation

Find the requirements and steps to create the connector in the Airbyte documentation.

Customized files

After creating the Airbyte connector template, modify the next files to retrieve data from North Carolina DOT .


Location: source-viawarn-us-nc-dot/spec.yaml
In this case, the connector password is specified in the spec file.
  title: VIAWARN USA NC DOT - Spec
  type: object
    - app_key
      type: string
      airbyte_secret: true
      description: APP Key obtained from



Location: secrets/config.json
This file is ignore by git.





Location: integration_tests/configure_catalog.json
List of Streams that describes the data in the data store that a Source represents. It also declares the sync modes supported by each stream (full refresh or incremental).
  "streams": [
      "stream": {
        "name": "work",
        "json_schema": {},
        "supported_sync_modes": ["full_refresh"]
      "sync_mode": "full_refresh",
      "destination_sync_mode": "overwrite"

Location: source-viawarn-us-nc-dot/

class ViawarnUsNcDotStream()

Create a stream to represent the data that will be pull from the API. It contains all the common API functionalities:
  •  url_base

This field is the common part of the URL for all streams, if it does not exist, add it in each stream method.


  • __init__()

This is a constructor method used to initialize the class. It uses the ‘config’ object to define the ‘developer_api_key’ attribute.

return config[]

  • next_page_token()

Pagination is not provided by this API.

return None

  • request_params()

The API requires the ‘Developer Key’ parameter in which the data will be passed.

return a dictionary

  • parse_response()

It is a placeholder to store the request.response object and constructs the appropriate mapping object for each parsed element by each Stream class.

yields an empty dictionary.

class Work()

This method extends the ViawarnUsNcDotStream() method to specified unique behavior for this stream.
  • primary_key

Unique field required in the stream associate to each output record.


  • path()

subdomain and parameters to pass into the URL.

return a string

  • parse_response()

Definition of how a response is parsed.

Set a definition to: primary key and ewkt fields.

return an iterable containing each record in the response.

class SourceViawarnUsNcDot()

  • check_connection()

Set up a test to verify the connection between the connector and the API. This test should return two variables: the first one is a boolean that indicates the status of the connection, while the second one shows a log message if the connection fails.

return True, None

  • streams()
Set up the stream in the source that will be parsed.
return List of streams


Location: source-viawarn-us-nc-dot/schemas/work.json
Declare stream schema by adding json file describing the output from that stream.
Streams name: work