Cloud Firestore API

googleapis · Analytics

Analytics No Auth Free & Open analytics media

Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development.

Authentication

No authentication requiredFree to use with no key needed.

Sample Requests

GET firestore.projects.databases.collectionGroups.fields.list

Lists the field configuration and metadata for this database. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to `indexConfig.usesAncestorConfig:false`.

https://api.apis.guru/v2/specs/googleapis.com/firestore/v1beta2/v1beta2/{parent}/fields?alt=json&key=YOUR_API_KEY&fields=example&filter=example&$.xgafv=1&callback=example&pageSize=1&pageToken=example&quotaUser=example&uploadType=example&oauth_token=example&prettyPrint=true&access_token=example&upload_protocol=example

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/googleapis.com/firestore/v1beta2/v1beta2/{parent}/fields?alt=json&key=YOUR_API_KEY&fields=example&filter=example&$.xgafv=1&callback=example&pageSize=1&pageToken=example&quotaUser=example&uploadType=example&oauth_token=example&prettyPrint=true&access_token=example&upload_protocol=example"

import requests
params = {
    "alt": "json",
    "key": "YOUR_API_KEY",
    "fields": "example",
    "filter": "example",
    "$.xgafv": "1",
    "callback": "example",
    "pageSize": "1",
    "pageToken": "example",
    "quotaUser": "example",
    "uploadType": "example",
    "oauth_token": "example",
    "prettyPrint": "true",
    "access_token": "example",
    "upload_protocol": "example"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/googleapis.com/firestore/v1beta2/v1beta2/{parent}/fields",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/googleapis.com/firestore/v1beta2/v1beta2/{parent}/fields');
url.searchParams.set('alt', 'json');
url.searchParams.set('key', 'YOUR_API_KEY');
url.searchParams.set('fields', 'example');
url.searchParams.set('filter', 'example');
url.searchParams.set('$.xgafv', '1');
url.searchParams.set('callback', 'example');
url.searchParams.set('pageSize', '1');
url.searchParams.set('pageToken', 'example');
url.searchParams.set('quotaUser', 'example');
url.searchParams.set('uploadType', 'example');
url.searchParams.set('oauth_token', 'example');
url.searchParams.set('prettyPrint', 'true');
url.searchParams.set('access_token', 'example');
url.searchParams.set('upload_protocol', 'example');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/googleapis.com/firestore/v1beta2/v1beta2/{parent}/fields")
	q := baseURL.Query()
	q.Set("alt", "json")
	q.Set("key", "YOUR_API_KEY")
	q.Set("fields", "example")
	q.Set("filter", "example")
	q.Set("$.xgafv", "1")
	q.Set("callback", "example")
	q.Set("pageSize", "1")
	q.Set("pageToken", "example")
	q.Set("quotaUser", "example")
	q.Set("uploadType", "example")
	q.Set("oauth_token", "example")
	q.Set("prettyPrint", "true")
	q.Set("access_token", "example")
	q.Set("upload_protocol", "example")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/googleapis.com/firestore/v1beta2/v1beta2/{parent}/fields")
uri.query = URI.encode_www_form({
  "alt" => "json",
  "key" => "YOUR_API_KEY",
  "fields" => "example",
  "filter" => "example",
  "$.xgafv" => "1",
  "callback" => "example",
  "pageSize" => "1",
  "pageToken" => "example",
  "quotaUser" => "example",
  "uploadType" => "example",
  "oauth_token" => "example",
  "prettyPrint" => "true",
  "access_token" => "example",
  "upload_protocol" => "example"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/googleapis.com/firestore/v1beta2/v1beta2/{parent}/fields?" . http_build_query([
    "alt" => "json",
    "key" => "YOUR_API_KEY",
    "fields" => "example",
    "filter" => "example",
    "$.xgafv" => "1",
    "callback" => "example",
    "pageSize" => "1",
    "pageToken" => "example",
    "quotaUser" => "example",
    "uploadType" => "example",
    "oauth_token" => "example",
    "prettyPrint" => "true",
    "access_token" => "example",
    "upload_protocol" => "example"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET firestore.projects.databases.collectionGroups.indexes.list

Lists composite indexes.

https://api.apis.guru/v2/specs/googleapis.com/firestore/v1beta2/v1beta2/{parent}/indexes?alt=json&key=YOUR_API_KEY&fields=example&filter=example&$.xgafv=1&callback=example&pageSize=1&pageToken=example&quotaUser=example&uploadType=example&oauth_token=example&prettyPrint=true&access_token=example&upload_protocol=example

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/googleapis.com/firestore/v1beta2/v1beta2/{parent}/indexes?alt=json&key=YOUR_API_KEY&fields=example&filter=example&$.xgafv=1&callback=example&pageSize=1&pageToken=example&quotaUser=example&uploadType=example&oauth_token=example&prettyPrint=true&access_token=example&upload_protocol=example"

import requests
params = {
    "alt": "json",
    "key": "YOUR_API_KEY",
    "fields": "example",
    "filter": "example",
    "$.xgafv": "1",
    "callback": "example",
    "pageSize": "1",
    "pageToken": "example",
    "quotaUser": "example",
    "uploadType": "example",
    "oauth_token": "example",
    "prettyPrint": "true",
    "access_token": "example",
    "upload_protocol": "example"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/googleapis.com/firestore/v1beta2/v1beta2/{parent}/indexes",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/googleapis.com/firestore/v1beta2/v1beta2/{parent}/indexes');
url.searchParams.set('alt', 'json');
url.searchParams.set('key', 'YOUR_API_KEY');
url.searchParams.set('fields', 'example');
url.searchParams.set('filter', 'example');
url.searchParams.set('$.xgafv', '1');
url.searchParams.set('callback', 'example');
url.searchParams.set('pageSize', '1');
url.searchParams.set('pageToken', 'example');
url.searchParams.set('quotaUser', 'example');
url.searchParams.set('uploadType', 'example');
url.searchParams.set('oauth_token', 'example');
url.searchParams.set('prettyPrint', 'true');
url.searchParams.set('access_token', 'example');
url.searchParams.set('upload_protocol', 'example');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/googleapis.com/firestore/v1beta2/v1beta2/{parent}/indexes")
	q := baseURL.Query()
	q.Set("alt", "json")
	q.Set("key", "YOUR_API_KEY")
	q.Set("fields", "example")
	q.Set("filter", "example")
	q.Set("$.xgafv", "1")
	q.Set("callback", "example")
	q.Set("pageSize", "1")
	q.Set("pageToken", "example")
	q.Set("quotaUser", "example")
	q.Set("uploadType", "example")
	q.Set("oauth_token", "example")
	q.Set("prettyPrint", "true")
	q.Set("access_token", "example")
	q.Set("upload_protocol", "example")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/googleapis.com/firestore/v1beta2/v1beta2/{parent}/indexes")
uri.query = URI.encode_www_form({
  "alt" => "json",
  "key" => "YOUR_API_KEY",
  "fields" => "example",
  "filter" => "example",
  "$.xgafv" => "1",
  "callback" => "example",
  "pageSize" => "1",
  "pageToken" => "example",
  "quotaUser" => "example",
  "uploadType" => "example",
  "oauth_token" => "example",
  "prettyPrint" => "true",
  "access_token" => "example",
  "upload_protocol" => "example"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/googleapis.com/firestore/v1beta2/v1beta2/{parent}/indexes?" . http_build_query([
    "alt" => "json",
    "key" => "YOUR_API_KEY",
    "fields" => "example",
    "filter" => "example",
    "$.xgafv" => "1",
    "callback" => "example",
    "pageSize" => "1",
    "pageToken" => "example",
    "quotaUser" => "example",
    "uploadType" => "example",
    "oauth_token" => "example",
    "prettyPrint" => "true",
    "access_token" => "example",
    "upload_protocol" => "example"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET firestore.projects.databases.collectionGroups.indexes.get

Gets a composite index.

https://api.apis.guru/v2/specs/googleapis.com/firestore/v1beta2/v1beta2/{name}?alt=json&key=YOUR_API_KEY&fields=example&$.xgafv=1&callback=example&quotaUser=example&uploadType=example&oauth_token=example&prettyPrint=true&access_token=example&upload_protocol=example

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/googleapis.com/firestore/v1beta2/v1beta2/{name}?alt=json&key=YOUR_API_KEY&fields=example&$.xgafv=1&callback=example&quotaUser=example&uploadType=example&oauth_token=example&prettyPrint=true&access_token=example&upload_protocol=example"

import requests
params = {
    "alt": "json",
    "key": "YOUR_API_KEY",
    "fields": "example",
    "$.xgafv": "1",
    "callback": "example",
    "quotaUser": "example",
    "uploadType": "example",
    "oauth_token": "example",
    "prettyPrint": "true",
    "access_token": "example",
    "upload_protocol": "example"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/googleapis.com/firestore/v1beta2/v1beta2/{name}",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/googleapis.com/firestore/v1beta2/v1beta2/{name}');
url.searchParams.set('alt', 'json');
url.searchParams.set('key', 'YOUR_API_KEY');
url.searchParams.set('fields', 'example');
url.searchParams.set('$.xgafv', '1');
url.searchParams.set('callback', 'example');
url.searchParams.set('quotaUser', 'example');
url.searchParams.set('uploadType', 'example');
url.searchParams.set('oauth_token', 'example');
url.searchParams.set('prettyPrint', 'true');
url.searchParams.set('access_token', 'example');
url.searchParams.set('upload_protocol', 'example');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/googleapis.com/firestore/v1beta2/v1beta2/{name}")
	q := baseURL.Query()
	q.Set("alt", "json")
	q.Set("key", "YOUR_API_KEY")
	q.Set("fields", "example")
	q.Set("$.xgafv", "1")
	q.Set("callback", "example")
	q.Set("quotaUser", "example")
	q.Set("uploadType", "example")
	q.Set("oauth_token", "example")
	q.Set("prettyPrint", "true")
	q.Set("access_token", "example")
	q.Set("upload_protocol", "example")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/googleapis.com/firestore/v1beta2/v1beta2/{name}")
uri.query = URI.encode_www_form({
  "alt" => "json",
  "key" => "YOUR_API_KEY",
  "fields" => "example",
  "$.xgafv" => "1",
  "callback" => "example",
  "quotaUser" => "example",
  "uploadType" => "example",
  "oauth_token" => "example",
  "prettyPrint" => "true",
  "access_token" => "example",
  "upload_protocol" => "example"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/googleapis.com/firestore/v1beta2/v1beta2/{name}?" . http_build_query([
    "alt" => "json",
    "key" => "YOUR_API_KEY",
    "fields" => "example",
    "$.xgafv" => "1",
    "callback" => "example",
    "quotaUser" => "example",
    "uploadType" => "example",
    "oauth_token" => "example",
    "prettyPrint" => "true",
    "access_token" => "example",
    "upload_protocol" => "example"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

Postman Setup Guide

Get Postman ↗

See official documentation for authentication and setup.

What can you build with Cloud Firestore API?

Cloud Firestore API is a Analytics API. Developers commonly use analytics APIs for:

tracking product usage and user behaviour
building custom reporting and BI dashboards
measuring marketing and campaign performance
running funnel, retention, and cohort analysis
aggregating metrics from multiple data sources

No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. Cloud Firestore API is free to use, making it a low-risk choice to experiment with.

New to APIs? Read our beginner's guide

Open documentation ↗