Skip to main content

Setup

To set up your custom domain for the API, you need to add a CNAME record in your DNS provider's settings. This process points your custom subdomain to our service, enabling a white-labeled experience under your own brand.

Instructions​

Follow these steps to configure your custom domain:

  1. Log in to your domain registrar's console. This is the service where you purchased your domain.

  2. Find your domain's DNS management page. This section is often labeled "DNS Management," "Name Server Management," or "Advanced DNS."

  3. Create a new CNAME record with the following details:

    • Type: CNAME
    • Name (or Host): api (Note: Some DNS providers require the full hostname, like api.example.com..)
    • Target (or Value): api.example.alreadyknow.finance.
    • TTL (Time to Live): You can leave this at the default setting (often 1 hour or "Automatic").

  4. Save your changes.

DNS changes can take a few minutes to an hour to propagate, but in some cases, it might take longer.

Example DNS Record​

If your domain is example.com, your CNAME record should look like this:

TypeName/HostTarget/Value
CNAMEapiapi.example.alreadyknow.finance.

Once the DNS record is active, requests to https://api.example.com will be correctly routed to the platform's infrastructure.