🔐 Authentication

Learn how to authenticate against our API.

The Linkup API can be accessed using the base URL: https://api.linkup.so/v1.

All endpoints are protected and require you to provide an API key, which you can get for free by creating an account on the Linkup App.

Using the Python SDK

Option 1: Set a LINKUP_API_KEY environment variable in your shell before using the SDK.

Shell

export LINKUP_API_KEY='<YOUR_LINKUP_API_KEY>'

Option 2: Set the LINKUP_API_KEY environment variable directly within Python, using for instance os.environ or python-dotenv.

Python

import os
from linkup import LinkupClient

os.environ["LINKUP_API_KEY"] = "<YOUR_LINKUP_API_KEY>"
# or dotenv.load_dotenv()
client = LinkupClient()
...

Option 3: Directly pass the Linkup API key to the Linkup Client.

Python

from linkup import LinkupClient

client = LinkupClient(api_key="<YOUR_LINKUP_API_KEY>")
...

Using the Node.js SDK

Coming soon :)

Using cURL

Your API key needs to be sent along all your request as a Bearer token in the Authorization header.

cURL

curl "https://api.linkup.so/v1/search" \
    -G \
    -H "Authorization: Bearer <YOUR_LINKUP_API_KEY>" \
    ...