> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vintr.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> In under 5 minutes, you will make your first API call.

# Get started

* [Sign up for Vintr.](https://www.vintr.xyz/login)
* Follow the steps on the screen to create an organization and add your billing details.
* Create an API key from your dashboard.

<Danger>
  Keep your API key private and use it only in server-side code.
</Danger>

# Resolve a location

Suppose you need to deliver food to Tom.

Tom's alias is tom#Vintr.

Pass the alias to the Vintr. API to get Tom's current location and delivery instructions.<br />

<CodeGroup>
  ```typescript Vintr. SDK theme={null}
  import { Vintr } from '@vintr/node-sdk';

  const vintr = new Vintr('api_key');

  const location = await vintr.alias.resolve({ alias: 'tom#vintr' });
  ```

  ```powershell Vintr. API theme={null}
  curl --request GET \
    --url https://api.vintr.xyz/tom#vintr \
    --header 'Authorization: Bearer <token>'
  ```

  ```json Response theme={null}
  {
    alias: "tom#vintr",
    type: "individual",
    location: {
      address: {
        line1: "1 Apple Park Way",
        line2: "",
        line3: "",
        city: "Cupertino",
        state: "California",
        postal_code: "95014",
        country: "US"
      },
      geo: {
        latitude: 37.335,
        longitude: -122.0092,
        altitude: null,
        precision_meters: 5
      },
      instructions: {
        general: "Enter through the main visitor entrance.",
        delivery: "Use the designated delivery entrance.",
        autonomous: "Approach from the east access road."
      }
    },
    createdAt: "2026-08-18T20:39:52.671Z",
    updatedAt: "2026-08-18T20:39:52.671Z"
  }
  ```
</CodeGroup>

# Pricing

You are billed per resolution on a monthly basis. \$1 for 1k API calls.