Skip to content

Documentation

Build something great in 5 minutes.

In short

Beginner-friendly guides and a full reference for every Geoverio API: authentication, endpoints, response fields and working examples you can copy.

Last reviewed 11 September 2026

Key facts

auth_method
Bearer token header
free_tier_status
genuinely free with no credit card required
response_format
JSON envelope

Never used an API before? Perfect — this guide assumes nothing. Follow three small steps below and you will make your first successful API call today. Promise.

Quickstart

Your first API call in 3 steps

Tick each step off as you go. No prior experience, no jargon, no credit card.

  1. Pick an email and a password — that is the whole signup. No credit card, and the free tier is genuinely free.

  2. Keys live inside projects, and a project needs a plan. Once you are signed in, choose a plan — the free tier counts — then open Dashboard → Projects, open a project and click Create key. You will get a long string that looks like this:

    gv_live_xxxxxxxxxxxxxxxxxxxxxxxx
    What’s an API key, anyway?

    Think of it as a password for programs. When your code talks to Geoverio, the key proves the request came from you — so we know whose account to count it against and what it is allowed to do.

    And just like a password: keep it secret. Don’t paste it in public chats, screenshots, or code you push to GitHub.

  3. Pick the API you want and the language you like. Every API on the platform works exactly the same way — one key, one header, JSON back — so whichever you start with, you have learned all of them.

    Returns the full intelligence report for one IPv4 or IPv6 address.

    # Keep the key in the environment, not in your shell history:
    #   export GEOVERIO_API_KEY="gv_live_…"
    
    curl --fail-with-body "https://ip.geoverio.com/v1/ip/8.8.8.8" \
      -H "Authorization: Bearer $GEOVERIO_API_KEY"
    // Call this from your server, never from the browser:
    // front-end JavaScript ships your key to every visitor.
    const KEY = process.env.GEOVERIO_API_KEY;
    
    async function main() {
      const res = await fetch(
        "https://ip.geoverio.com/v1/ip/8.8.8.8",
        { headers: { Authorization: `Bearer ${KEY}` } }
      );
    
      // Never parse the body before checking the status: an expired key answers
      // 401 with a perfectly valid JSON envelope.
      if (!res.ok) {
        throw new Error(`HTTP ${res.status} — ${await res.text()}`);
      }
    
      console.log(await res.json());
    }
    
    main().catch((err) => {
      console.error(err);
      process.exitCode = 1;
    });
    # pip install requests
    import os, requests
    
    url = "https://ip.geoverio.com/v1/ip/8.8.8.8"
    headers = {"Authorization": "Bearer " + os.environ["GEOVERIO_API_KEY"]}
    
    r = requests.get(url, headers=headers)
    r.raise_for_status()   # turns 4xx / 5xx into an exception instead of silent bad data
    print(r.json())
    <?php
    // Read the key from the server environment — never commit it.
    $key = getenv('GEOVERIO_API_KEY');
    
    $ch = curl_init("https://ip.geoverio.com/v1/ip/8.8.8.8");
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_HTTPHEADER, [
        "Authorization: Bearer $key",
        "Accept: application/json",
    ]);
    
    $body   = curl_exec($ch);
    $status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
    curl_close($ch);
    
    if ($status < 200 || $status >= 300) {
        fwrite(STDERR, "Request failed — HTTP $status: $body\n");
        exit(1);
    }
    
    print_r(json_decode($body, true));

    Full reference for this API: IP Lookup documentation.

    Put the key from step 2 in an environment variable called GEOVERIO_API_KEY — on macOS or Linux that is export GEOVERIO_API_KEY="gv_live_…" — then run it. That’s it. Really. Keeping the key in the environment rather than in the code is what stops it ending up in your shell history or a git commit.

API catalog

Pick your API

Every API works the same way: one key, one Bearer header, clean JSON back. Choose one and dive in.

IP Lookup

Geolocation, network owner, VPN/proxy/Tor detection and a risk score for any IP

Read the docs

Payroll

US payroll, gross to net, in one call.

Read the docs

Core concepts

Four things, and you know the whole platform

Every Geoverio API follows the same rules. Learn them once, use them everywhere.

Authentication
Send your key in one header on every request: Authorization: Bearer YOUR_API_KEY. That’s the entire auth story.
Rate limits
Every response carries X-RateLimit-* headers showing how many requests you have left, so your code is never surprised.
Errors
When something goes wrong you get a standard HTTP code (like 404 or 429) plus a JSON body that explains how to fix it.
Response format
Every endpoint is JSON over HTTPS, authenticated the same way, and every failure carries the same detail field. The success shape is specific to each API — its reference page lists every field it returns.

For AI assistants

Building this with an AI? Give it these.

If you are asking Claude, ChatGPT, Cursor or Copilot to build against Geoverio — a plugin, an integration, a checkout flow — point it at the files below instead of at these pages. They are the complete reference as plain Markdown: every endpoint, parameter, response field, error code and worked example, plus the mistakes that trip implementers up. Generated from the same specification this site renders, so they are never out of date.

The whole platform in one file. This is the one to paste into a chat or drop into your project as context — it covers every API, with working code and integration recipes.
A short index of every API and where to find its reference. Useful when the assistant can follow links itself and you would rather not spend the context window.
/docs/<api>.md
One API on its own — for example /docs/ip-lookup.md. Add .md to any reference page URL.
One thing to tell it
Assistants happily write the API key straight into front-end code. Ask for the calls to be made server-side with the key read from an environment variable — the reference says so, but it is worth saying twice.

Ready to make it real?

Grab your free API key and turn the examples above into your own app.

Frequently asked questions

Do I need to install software to use Geoverio?
No prior experience is required. You create a free account by picking an email and password, then grab your API key from the dashboard before making your first call.
Where should I store my API key?
Keep the key in your server environment variables. Never paste it in public chats, screenshots, or code you push to GitHub to keep it secret.
Can AI assistants parse error responses correctly?
Yes. An expired key returns a 401 status with a valid JSON envelope. You must check the status before parsing the body to handle errors properly.