Flutter: Initializing

You can initialize Supabase with the static initialize() method of the Supabase class.

The Supabase client is your entrypoint to the rest of the Supabase functionality and is the easiest way to interact with everything we offer within the Supabase ecosystem.

Parameters

• url

  (Required)

  The unique Supabase URL which is supplied when you create a new project in your project dashboard.

• publishableKey

  (Required)

  The publishable (anon) key supplied when you create a new project in your project dashboard. Use this for client-side apps. The deprecated `anonKey` parameter is still accepted but `publishableKey` takes precedence when both are supplied.

• headers

  (Optional)

  Custom header to be passed to the Supabase client.

• httpClient

  (Optional)

  Custom http client to be used by the Supabase client.

• authOptions

  (Optional)

  Options to change the Auth behaviors.

• postgrestOptions

  (Optional)

  Options to change the Postgrest behaviors.

• realtimeClientOptions

  (Optional)

  Options to change the Realtime behaviors.

• storageOptions

  (Optional)

  Options to change the Storage behaviors.

Examples

For Flutter

Future<void> main() async {
  await Supabase.initialize(
    url: 'https://xyzcompany.supabase.co',
    publishableKey: 'your-publishable-key',
  );

  runApp(MyApp());
}

// Get a reference your Supabase client
final supabase = Supabase.instance.client;

For other Dart projects

final supabase = SupabaseClient(
  'https://xyzcompany.supabase.co',
  'your-secret-key', // use your secret key for server-side usage
);