🔑Getting your API key

How to retrieve your Cityweft API key for plugins

What is an API key?

An API key is your token used to validate requests to our platform from third-party applications, such as Cityweft plugins. Your API key is unique to your account and is directly linked to your billing and usage. It should therefore be protected to ensure that only authorized systems can access your data and use Cityweft services on your behalf. Never share your key publicly.

1. Go to the Cityweft web platform

   Open your browser and go to: app.cityweft.com and log in to your account.

   If you do not already have an account, simply sign up using your Google, LinkedIn, or Email.

   
2. Open the “API & Plugin Keys” page

   In the left-hand menu, go to “API & Plugin Keys”.

   
3. API / Plugin Keys Page

   • On the API & Plugin Keys page you can view, manage, and issue your API Keys

   • The first time you open the page, you will automatically be issued 1 km2 of free export

   

   Retrieve your API Token

   • To retrieve your API token, simply press the ‘View Token’ button

     
   • Here you can view and copy your unique token. If your token has been exposed or leaked, you can always re-issue the token using the ‘refresh’ button on the right.

   • Reissuing a token will deactivate your previous token permanently.

     

   Monitor your usage

   • The numbers and charts on the page show all recorded usage of your API key, including:

     • Total requests made

     • Total area requested (km2)

     • Average area per request (km2)

     • Chart overview of usage

   Adding balance to your account

   • If you have no balance left on your account, you will not be able to use the API key to request additional models and data.

   • To purchase credits, visit the Plan & Billing page to purchase a subscription or bundle

5. Check that you have an active subscription or bundle

• Click on “Plan & Billing” in the menu.

• To get an API token, you must have an active subscription or bundle.

You need an active plan in order to generate and use API/plugin keys.

• If you do not have an existing subscription or bundle, simply choose any bundle or subscription that matches your needs.