# Get started with the High Volume API

> Activate HV SERP API, get a key, and make your first request.

Canonical: https://docs.georanker.com/docs/hv-api-getting-started

The High Volume API appears as **HV SERP API** in the GeoRanker Platform. Use this service to request search engine results from your own application. Each person who makes requests needs an active High Volume API key and credits assigned to them.

## Activate HV SERP API

* If you are new to GeoRanker, select **Create an account** on the sign-in screen. Enter your account details, choose **HV SERP API** and select **Continue to setup**. [GeoRanker Platform](https://platform.georanker.com)
* Set your monthly request volume, pages per request, priority and billing interval. Select **Review your plan** to check the credit allowance, amount due today and renewal terms. Complete payment and return to the Platform for confirmation.
* If you already own a GeoRanker account, open **Services**. On the **HV SERP API** card, select **View service plans**, then **Subscribe** for a recurring allowance. If the card shows **Payment pending**, complete the existing checkout. Once active, the card offers **View service details**.
* If a colleague manages the subscription, ask your owner or an admin to add you to the **HV SERP API** team and issue a key in your name.

## Get a key and check its balance

* As an owner or admin, open **Services**, select **View service details** on **HV SERP API**, then open **API keys**. For an existing key, use **Show this key** and **Copy** if those controls are available.
* To issue a key, select **New key**, choose the person under **Issue to**, enter a name and select **Create key**. Copy the key and store it securely. Wait for its status to change from **Activating** to **Active**. Issuing another key for the same person replaces their previous HV key.
* Open **Credits** to check the key holder's balance. An owner can select **Move mine** beside a colleague to transfer credits, or **Buy for them** to purchase credits for that person. Transferred credits keep their original expiry date.

## Check your connection

Open the API reference and select **Sign in with API key**, then **Connect for 30 days**. Choose **Get account details** (`GET /user`) and select **Test Request**. A successful response contains a `credits` array. Each entry includes its `total`, `remaining` and `expiresAt` values. [Get account details](https://docs.georanker.com/reference/getuser)

To make the same request from your server, set `HV_API_KEY` from your secret store. These examples use cURL 7.87 or later. Keep URLs containing the key out of shared logs.

```sh
curl --url-query "apikey=$HV_API_KEY" \
  'https://api.highvolume.georanker.com/user'
```

## Request search results

Creating a search report uses account credits. This example requests up to ten Google results for `coffee roasters` in the United States. [Create SERP](https://docs.georanker.com/reference/addserp)

```sh
curl --request POST 'https://api.highvolume.georanker.com/serp/new' \
  --url-query "apikey=$HV_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"keyword":"coffee roasters","region":"US","searchEngine":"google","maxResults":10,"asynchronous":true}'
```

Copy the `id` from the response and replace `YOUR_REPORT_ID` below. If `ready` and `faulty` are both `false`, wait and check the same report ID again. When `ready` is `true` and `faulty` is `false`, read the organic results in `data.organic`. [Get SERP results](https://docs.georanker.com/reference/getserp)

```sh
curl --url-query "apikey=$HV_API_KEY" \
  'https://api.highvolume.georanker.com/serp/YOUR_REPORT_ID'
```

If the API returns **403**, check that the key is active and belongs to HV SERP API. For **402**, check the holder's **Credits** balance and the **Rate limits** tab in the service details. **Analytics** shows credit use by date and priority.

[High Volume API](https://docs.georanker.com/docs/hv-api)
