Skip to main content

Punk-API

This page contains the setup guide and reference information for the Punk-API source connector.

Prerequisites

Api key is not required for this connector to work,But a dummy key need to be passed to enhance in next versions. Example:123

Setup guide

Step 1: Set up Punk-API connection

  • Pass a dummy API key (Example: 12345)
  • Params (Optional ID)

Step 2: Set up the Punk-API connector in Airbyte

For Airbyte Cloud:

  1. Log into your Airbyte Cloud account.
  2. In the left navigation bar, click Sources. In the top-right corner, click +new source.
  3. On the Set up the source page, enter the name for the Punk-API connector and select Punk-API from the Source type dropdown.
  4. Enter your dummy api_key.
  5. Enter the params configuration if needed: ID (Optional)
  6. Click Set up source.

For Airbyte OSS:

  1. Navigate to the Airbyte Open Source dashboard.
  2. Set the name for your source.
  3. Enter your dummy api_key.
  4. Enter the params configuration if needed: ID (Optional)
  5. Click Set up source.

Supported sync modes

The Punk-API source connector supports the following sync modes:

FeatureSupported?
Full Refresh SyncYes
Incremental SyncNo
Replicate Incremental DeletesNo
SSL connectionYes
NamespacesNo

Supported Streams

  • Beers
  • Beers_with_ID

API method example

GET https://api.punkapi.com/v2/beers

Performance considerations

Punk API's API reference has v2 at present and v1 as depricated. The connector as default uses v2.

Reference

Config fields reference

Field
Type
Property name
string
brewed_before
string
brewed_after
string
id

Changelog

Expand to review
VersionDatePull RequestSubject
0.1.22024-06-0639158[autopull] Upgrade base image to v1.2.2
0.1.12024-05-2038441[autopull] base image + poetry + up_to_date
0.1.02022-10-31InitInitial commit