Neon is Generally Available! Serverless Postgres with branching to boost your development velocity.Read more

SDKs for the Neon API

Neon provides support for the @neondatabase/api-client library, which is a wrapper for the Neon API. It provides a convenient way to interact with the Neon API using TypeScript.


You can install the library using npm or yarn.


npm install @neondatabase/api-client


yarn add @neondatabase/api-client

Get Started

To get started with the @neondatabase/api-client library, follow these steps:

  1. Obtain an API key from the Developer Settings page in the Neon Console.

  2. Click Generate new API key.

  3. Enter name for your API key and click Create.

  4. Save your API key to a secure location that enables you to pass it to your code.

  5. Import the library:

    import { createApiClient } from '@neondatabase/api-client';
  6. Create an instance of the API client by calling the createApiClient function:

    const apiClient = createApiClient({
    apiKey: 'your-api-key',
  7. Use the apiClient instance to make API calls. For example:

    const response = await apiClient.listProjects({});

Community SDKs

The following is a list of community-created SDKs for interacting with the Neon API.


Community SDKs are not maintained or officially supported by Neon. Some features may be out of date, so use these SDKs at your own discretion. If you have questions about these SDKs, please contact the the project maintainers.

Last updated on

Edit this page
Was this page helpful?