Add Halliday To Your Project

Contact a Halliday representative

If we do not already support your token, we can do so very quickly. Simply get in touch with us here and share which token you'd like support for, as well as any preferred bridges and/or exchanges you'd like us to leverage.

Obtain API Keys

Your Halliday API key authenticates you to our servers across all our services.

To create API keys, visit the Halliday Dashboard (opens in a new tab) and sign up or log in. After you are successfully logged in, click "API Key Management" in the left sidebar:

Then, click "Create new key". You can create multiple API keys and view and manage them on this page.

To create Sandbox API keys for testing, simply click "Sandbox" tab near the top-left of the page (to the right of the Halliday logo). Be sure to switch to the "Production" tab (currently active) for creating live production keys.

Integrate!

First, install the Halliday SDK:

npm install @halliday-sdk/commerce

Once you've done that, integrating Halliday into your application is as simple as a few lines of code:

import { openHalliday } from "@halliday-sdk/commerce";
 
// openHalliday will open a popup that begins the onramp flow.
// Customize the button to match your site's aesthetic.
<Button
    onClick={() => {
        openHalliday({
            apiKey: HALLIDAY_PUBLIC_API_KEY,
            destinationBlockchainType: "ARBITRUM",
            destinationCryptoType: "ETH_ARBITRUM",
        });
    }}
>
    Onramp with Halliday
</Button>;

And that's it! You're now doing commerce with Halliday.