@neondatabase/api-client

@neondatabase/api-client

Introduction

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

Installation

You can install the library using npm or yarn.

npm:

npm install @neondatabase/api-client

yarn:

yarn add @neondatabase/api-client

Get Started

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

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

• Click Generate new API key.

• Enter name for your API key and click Create.

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

• Import the library:

  import { createApiClient } from '@neondatabase/api-client';
  

• Create an instance of the API client by calling the createApiClient function:

  const apiClient = createApiClient({
    apiKey: 'your-api-key',
  });
  

• Use the apiClient instance to make API calls. For example:

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

API Reference

https://api-docs.neon.tech/

Configuration

Since the client is based on axios library, createApiClient additionally accepts axios request options.

License

The @neondatabase/api-client library is licensed under the MIT License. For more information, see the LICENSE file.