Account, API Keys, Rate Limits

GeneBe's resources are limited. To ensure fair usage, we restrict access to the API. Users without a GeneBe account can only make a limited number of queries from a single computer (i.e., one IP address). If this is insufficient, please create an account and obtain an API key by logging in and visiting your profile page. Once you have an API key, include it in your API requests.

Creating an Account

To create an account go to https://genebe.net and click "Log in" button. After the creation visit your profile page and create an API key by clicking "Generate New API Key" button. Remember to store your API key in safe place.

Account API

You can check the API response by visiting the following endpoint in your browser: https://api.genebe.net/cloud/api-public/v1/whoami

Alternatively, you can use curl. Here’s an example without an API key:

curl -X 'GET' --silent \
  'https://api.genebe.net/cloud/api-public/v1/whoami' \
  -H 'accept: */*'

The response may look like this:

{
  "identifier": "ip#174.251.13.12",
  "ip": "174.251.13.12",
  "organizations": null,
  "account_id": null,
  "account_plan": null,
  "requests_get_variant": 1,
  "requests_post_variant": null,
  "variants_post_variant": null
}

Here’s an example with an API key:

EMAIL="my@email.com"
API_KEY="ak-efefef..."

curl -X 'GET' --silent \
   -u ${EMAIL}:${API_KEY} \
  'https://api.genebe.net/cloud/api-public/v1/whoami' \
  -H 'accept: */*'

The response may look like this:

{
  "identifier": "user#1",
  "accountId": 1,
  "accountPlan": "SMALL",
  "requests_get_variant": 1,
  "requests_post_variant": null,
  "variants_post_variant": null,
  "organizations": []
}

• requests_get_variant represents the count of the requests you've made using the GET request.
• requests_post_variant represents the count of the requests you've made using the GET request.
• variants_get_variant represents the count of the variants you've checked using the POST request.

OpenAPI Documentation

You can find interactive API documentation in our OpenAPI documentation here: https://api.genebe.net/cloud/gb-api-doc/swagger-ui/index.html#/account-public-controller/me

Rate Limits

Current rate limits are presented in the table below.

When you are not logged in, you are on the ANONYMOUS plan, which is shared with other users sharing the same IP address. Upon creating an API key, you will receive the SMALL plan. If this plan does not meet your needs, please contact us and let us know how we can assist you.