swift_small_white Created with Sketch.

Getting Started

Supported platforms

Our Swift client is supported on iOS, macOS, tvOS and watchOS, and is usable from both Swift and Objective-C.

Install

  • add a dependency on AlgoliaSearch-Client-Swift:
    • CocoaPods: add pod 'AlgoliaSearch-Client-Swift', '~> 4.0' to your Podfile
    • Carthage: add github "algolia/algoliasearch-client-swift" to your Cartfile
  • add import AlgoliaSearch to your source files

Init Index

To begin, you will need to initialize the client. In order to do this you will need your Application ID and API Key. You can find both on your Algolia account.

let client = Client(appID: "YourApplicationID", apiKey: "YourAPIKey")

The api key that is displayed here is your ADMIN API Key. To maintain security, never use your ADMIN API Key on your frontend or share it with anyone. In your frontend, use the SEARCH ONLY API Key or any other key that has search only rights.

If you are building a native app on mobile, be sure to not include the search API key directly in the source code. You should instead consider fetching the key from your servers during the app’s startup.