Neon Data API
The Neon Data API is the HTTP query service in the Neon backend for apps and agents. It provides a secure, stateless interface to your database, letting you access and manage your data directly from w...
The Neon Data API is the HTTP query service in the Neon backend for apps and agents. It provides a secure, stateless interface to your database, letting you access and manage your data directly from web browsers, serverless functions, and edge runtimes using standard HTTP methods. Key benefits include:
- Browser and edge compatibility. Standard Postgres drivers don't work in web browsers and struggle in edge runtimes, so query from Cloudflare Workers, Vercel Edge, or a browser frontend over standard HTTP.
- Connectionless scalability. Short-lived HTTP requests replace persistent TCP connections, so you avoid connection pool exhaustion and scale to thousands of concurrent users.
- Secure by default. The API validates JWTs from any authentication provider and respects PostgreSQL Row-Level Security (RLS) policies, so users only access data they're permitted to see. Use Managed Better Auth, or bring your own provider like Auth0, Clerk, or Firebase.
- CI/CD integration. Test integrations in isolated branch environments with the Neon Create Branch GitHub Action, which retrieves branch-specific Data API URLs for your workflows.
PostgREST compatibility
Section titled “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
Section titled “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 TypeScript SDK
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.
Need help?
Section titled “Need help?”Join our Discord Server to ask questions or see what others are doing with Neon. For paid plan support options, see Support.