Neon Data API

The Neon Data API provides a secure, stateless HTTP interface to your database. It allows you to access and manage your data directly from web browsers, serverless functions, and edge runtimes using standard HTTP methods. Key benefits include:

• Browser & edge compatibility

  Standard Postgres drivers do not work in web browsers and struggle in edge runtimes. The Data API allows you to query your database from Cloudflare Workers, Vercel Edge, or directly from a browser-based frontend using standard HTTP requests.

• Connectionless scalability

  Eliminate connection pool exhaustion. Because the API uses short-lived HTTP requests instead of persistent TCP connections, it effortlessly handles thousands of concurrent users and serverless auto-scaling.

• Secure by default

  The API is designed to expose your database safely. It integrates with Neon Auth and respects PostgreSQL Row-Level Security (RLS) policies, ensuring users only access the data they are explicitly permitted to see.

• CI/CD integration

  Test your Data API integrations in isolated branch environments using the Neon Create Branch GitHub Action, which can retrieve branch-specific Data API URLs for your workflows.

PostgREST compatibility

The Neon Data API is fully compatible with PostgREST. This compatibility allows you to query your database using any standard HTTP client (such as Postman or cURL) or integrate easily using client libraries, including @neondatabase/neon-js and @neondatabase/postgrest-js.

Quickstart

• Get Started

  Learn how to enable and use the Neon Data API with step-by-step instructions.

• Tutorial

  Explore our demo note-taking app to learn Data API queries with RLS.

• Neon Auth & Data API TypeScript SDKs

  Complete reference for authentication and database query methods.

• SQL to REST Converter

  Convert SQL queries into RESTful HTTP requests.

• Generate Types

  Generate TypeScript types from your database schema for type-safe queries.