Getting Started with the Looker API

On this Page
Docs Menu

The Looker API is a secure, "RESTful" application programming interface for managing your Looker instance, and fetching data through the Looker data platform. With the Looker API you can write applications or automation scripts to provision new Looker user accounts, run queries, schedule reports, etc. Just about anything you can do in the Looker application you can do via the Looker API.

Looker API Port and Path

The Looker API is implemented by your Looker instance. The default port for API requests is port 19999. This port number can be changed in your Looker configuration. If the default port doesn't respond, check with your Looker admin. All Looker API endpoints require an HTTPS connection.

Here's what a Looker API URL looks like with the default port: https://<your-looker-host-name>:19999/api/3.0/user

Client SDKs

You can use the Looker API with any programming language or application environment that can make HTTPS requests and process JSON responses. You can construct Looker API HTTPS requests manually using curl (or equivalent), the Looker Ruby SDK, or by generating a client SDK library for your language of choice. We recommend using a SDK because it takes care of the details of authentication and HTTPS requests for you, so that you can call the Looker API using simple function calls.

You'll find SDK details on our Looker API SDKs page.

Authentication

Looker authenticates API requests using an OAuth 2.0 bearer access token in the HTTP authorization header of the request. All Looker API endpoints require a secure HTTPS connection so that the access token will be secure in transit.

The steps for achieving this depend upon whether or not you are using a SDK. Detailed instructions can be found on our Looker API Authentication page.

Interactive API Documentation

In addition to the API reference in our online documentation, each Looker instance provides a local "api-doc" page. This local page always reflects the exact state of the Looker API on your Looker instance, because it's generated from the code running in your Looker instance.

This "api-doc" page combines a reference with a browser-based, interactive API explorer. For each Looker API endpoint you can fill in parameters, click the Try It Out! button, and immediately see the results of the API call. This can be a great way to become familiar with the Looker API without having to create a programming project and write supporting code. Keep in mind that, in order to use the Try It Out! buttons, you will first need to create API3 credentials so that your instance stays secure.

The default port and URL for the Looker instance API doc is https://<your-looker-host-name>:19999/api-docs/index.html. If the default url doesn't respond, check with your Looker admin to get the correct URL for your Looker installation.

Versioning

API stability is an important consideration when building applications. In order to help you understand which endpoints may be changed in the future, and which should remain stable, we mark certain endpoints as being in beta. For more details see our Looker API Versioning page.

Legacy API and SDK

Documentation for our old API can be found here, while the old SDK can be found here.

Still have questions?
Go to Discourse - or - Email Support
Top