home User Guide Getting Started Help Center Documentation Community Training Certification
menu
close
settings
Looker keyboard_arrow_down
language keyboard_arrow_down
English
Français
Deutsch
日本語
search
print
Looker documentation will be moving to cloud.google.com in mid-2022!
All the information you rely on will be migrated and all docs.looker.com URLs will be redirected to the appropriate page.
Getting started with the Looker API

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 path and port

Access your Looker instance’s API through its API URL.

Your Looker admin can specify an API path by entering it in the API Host URL field on the Admin > API page in one of the following formats:

https://<instance_name>.api.looker.com

or:

https://<instance_name>.api.<my_region>.looker.com

or:

https://<instance_name>.looker.com

Your Looker admin may also use the API Host URL field to assign an API path that is different from your Looker server machine name. This is common when your Looker installation is behind a load balancer, for example. In this case, contact your Looker admin for your API path.

If your Looker admin has not specified the API Host URL field, Looker uses the default API path. For Looker instances hosted on Google Cloud Platform (GCP), Microsoft Azure, and instances hosted on Amazon Web Service (AWS) that were created on or after 07/07/2020, the default Looker API path uses port 443. For Looker instances hosted on AWS that were created before 07/07/2020, the default Looker API path uses port 19999. The default API URL is in the following format:

https://<instance_name>.looker.com:<port>

The API URLs above connect to the default API version 3.1. You can also connect to the deprecated API version 3.0 by specifying it in the URL with the format https://<instance_name>.looker.com:<port>/api/3.0/user or https://<instance_name>.api.looker.com/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 by using curl (or equivalent), by using the Looker Ruby SDK, or by generating a client SDK library for your language of choice. We recommend using an 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 documentation page.

Authentication

Looker authenticates API requests by 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 an SDK. Detailed instructions can be found on our Looker API authentication documentation page.

Interactive API documentation

For API reference documentation, the API Explorer extension is available from the Looker Marketplace. For more information, see the Using the API Explorer documentation page. If you are a Looker admin, you can also access the API Explorer by clicking the Use API Explorer link on Looker’s API Admin page.

If you don’t have access to a Looker instance on which the API Explorer is installed, you can view a public version on Looker’s Developer Portal.

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 the Looker API versioning documentation page.

Top