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

# Introduction

> Welcome to the Vepler API documentation

<Frame>
  <img src="https://mintlify.s3.us-west-1.amazonaws.com/vepler-46f161ba/images/header.png" alt="Vepler API" />
</Frame>

## Welcome to Vepler API

The definitive API for UK property technology. Access 30M+ properties, 8M+ planning applications, 32K schools, and comprehensive safety data through a single, type-safe API.

```typescript theme={null}
import { SDK } from '@vepler/sdk';

const vepler = new SDK({ apiKey: process.env.VEPLER_API_KEY });

// Get comprehensive property data
const response = await vepler.property.getV1PropertyLocationIds({
  locationIds: 'p_0x123456789'
});
```

## What Can You Build?

<CardGroup cols={2}>
  <Card title="Property Search & Discovery" icon="magnifying-glass">
    Build advanced property search with 30M+ UK properties. Filter by location, price, features, and more.
  </Card>

  <Card title="Automated Valuations (AVMs)" icon="calculator">
    Create valuation models with historical prices, comparable sales, and market trends.
  </Card>

  <Card title="Market Analysis & Research" icon="chart-line">
    Analyse property markets, identify trends, and generate insights with comprehensive data.
  </Card>

  <Card title="Due Diligence Tools" icon="shield-check">
    Assess properties with planning history, crime data, school information, and more.
  </Card>
</CardGroup>

## Quick Start

<Steps>
  <Step title="Get Your API Key">
    Sign up at [app.vepler.com](https://app.vepler.com) and get your API key from the dashboard.
  </Step>

  <Step title="Install the SDK">
    ```bash theme={null}
    npm install @vepler/sdk
    ```
  </Step>

  <Step title="Make Your First Request">
    ```typescript theme={null}
    import { SDK } from '@vepler/sdk';

    const vepler = new SDK({ apiKey: 'vpr_live_...' });
    const response = await vepler.property.getV1PropertyLocationIds({
      locationIds: 'p_0x123456789'
    });
    ```
  </Step>
</Steps>

<CardGroup cols={3}>
  <Card title="Full Guide" icon="book" href="/quickstart">
    Complete quick start guide
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/introduction">
    Browse all endpoints
  </Card>

  <Card title="TypeScript SDK" icon="package" href="/sdk/typescript">
    SDK documentation
  </Card>
</CardGroup>

## Key Concepts

### Properties and Locations

```typescript theme={null}
// A location can have multiple properties (e.g., flats in a building)
const properties = await vepler.property.getV1PropertyLocationIds({
  locationIds: 'loc_123'
});

// Get multiple properties at once
const batch = await vepler.property.getV1PropertyPropertyIdPropertyIds({
  propertyIds: 'prop_1,prop_2,prop_3'
});
```

**Location ID**: Groups properties at the same address (e.g., flats 1-10 in a building)
**Property ID**: Unique identifier for a specific property unit
**Source ID**: Original identifier from data source (e.g., Land Registry UPRN)

### Advanced Querying

```typescript theme={null}
// Query with filters, pagination, and sorting
const results = await vepler.property.postV1PropertyQuery({
  area: [{
    type: 'point',
    coordinates: [51.5074, -0.1278],
    radius: 2000
  }],
  query: {
    propertyType: ['flat'],
    beds: [2, 3, 4],
    priceMax: 50000000  // in pence
  },
  limit: 50,
  offset: 0,
  sortBy: 'price',
  sortOrder: 'asc'
});
```

## Data Coverage

Our API provides access to comprehensive UK property data:

| Dataset            | Coverage                        | Data Source                         |
| ------------------ | ------------------------------- | ----------------------------------- |
| **Properties**     | 30M+ properties                 | Land Registry, VOA, Ordnance Survey |
| **Planning**       | 8M+ applications                | 350+ Local Planning Authorities     |
| **Schools**        | 32,000 schools                  | Ofsted, DfE                         |
| **Crime & Safety** | National coverage               | Police.uk                           |
| **Price Paid**     | Historical data from 1995       | HM Land Registry                    |
| **Listings**       | Active and historical           | Multiple providers                  |
| **EPC**            | Energy performance certificates | MHCLG                               |
| **Companies**      | Companies House data            | Companies House                     |

### Geographic Coverage

* **England**: Complete coverage
* **Wales**: Complete coverage
* **Scotland**: Property and planning data
* **Northern Ireland**: Limited coverage

## API Features

<CardGroup cols={3}>
  <Card title="Type-Safe SDK" icon="shield-check">
    Full TypeScript support with auto-completion and type checking
  </Card>

  <Card title="Advanced Filtering" icon="filter">
    Query by location, price, features, and custom criteria
  </Card>

  <Card title="Bulk Operations" icon="layer-group">
    Fetch multiple properties in a single request
  </Card>

  <Card title="80 Endpoints" icon="code">
    Property, planning, schools, safety, AVM, listings, address, and more
  </Card>

  <Card title="Pagination" icon="list">
    Offset-based pagination for navigating large datasets
  </Card>

  <Card title="Field Selection" icon="eye">
    Request only the data you need to optimise performance
  </Card>
</CardGroup>

## Next Steps

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/authentication">
    Set up API authentication
  </Card>

  <Card title="Quick Start Guide" icon="rocket" href="/quickstart">
    Build your first integration
  </Card>

  <Card title="Property API" icon="house" href="/api-reference/property/get-properties-by-location-ids">
    Explore property endpoints
  </Card>

  <Card title="TypeScript SDK" icon="code" href="/sdk/typescript">
    Use the TypeScript SDK
  </Card>
</CardGroup>

## Need Help?

* **Email**: [hello@vepler.com](mailto:hello@vepler.com)
* **Documentation**: Browse this site for guides and references
* **API Status**: Check service health via [/health](/api-reference/health/property-service-health-check) endpoints