Firebase Firestore Import
Pricing
Pay per usage
Go to Store
Firebase Firestore Import
This actor is designed to simplify the process of transferring data from an Apify dataset into a Firebase Firestore collection. Simply configure the actor with your Firebase credentials, Firestore collection ID, and dataset ID, and it will handle the rest, including optional data transformations.
0.0 (0)
Pricing
Pay per usage
1
Monthly users
2
Runs succeeded
98%
Last modified
2 years ago
You can access the Firebase Firestore Import programmatically from your own applications by using the Apify API. You can also choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in Integrations settings in Apify Console.
1{
2 "openapi": "3.0.1",
3 "info": {
4 "version": "0.0",
5 "x-build-id": "sqzoFzW64PamRJm6q"
6 },
7 "servers": [
8 {
9 "url": "https://api.apify.com/v2"
10 }
11 ],
12 "paths": {
13 "/acts/danielwebr~firebase-firestore-import/run-sync-get-dataset-items": {
14 "post": {
15 "operationId": "run-sync-get-dataset-items-danielwebr-firebase-firestore-import",
16 "x-openai-isConsequential": false,
17 "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
18 "tags": [
19 "Run Actor"
20 ],
21 "requestBody": {
22 "required": true,
23 "content": {
24 "application/json": {
25 "schema": {
26 "$ref": "#/components/schemas/inputSchema"
27 }
28 }
29 }
30 },
31 "parameters": [
32 {
33 "name": "token",
34 "in": "query",
35 "required": true,
36 "schema": {
37 "type": "string"
38 },
39 "description": "Enter your Apify token here"
40 }
41 ],
42 "responses": {
43 "200": {
44 "description": "OK"
45 }
46 }
47 }
48 },
49 "/acts/danielwebr~firebase-firestore-import/runs": {
50 "post": {
51 "operationId": "runs-sync-danielwebr-firebase-firestore-import",
52 "x-openai-isConsequential": false,
53 "summary": "Executes an Actor and returns information about the initiated run in response.",
54 "tags": [
55 "Run Actor"
56 ],
57 "requestBody": {
58 "required": true,
59 "content": {
60 "application/json": {
61 "schema": {
62 "$ref": "#/components/schemas/inputSchema"
63 }
64 }
65 }
66 },
67 "parameters": [
68 {
69 "name": "token",
70 "in": "query",
71 "required": true,
72 "schema": {
73 "type": "string"
74 },
75 "description": "Enter your Apify token here"
76 }
77 ],
78 "responses": {
79 "200": {
80 "description": "OK",
81 "content": {
82 "application/json": {
83 "schema": {
84 "$ref": "#/components/schemas/runsResponseSchema"
85 }
86 }
87 }
88 }
89 }
90 }
91 },
92 "/acts/danielwebr~firebase-firestore-import/run-sync": {
93 "post": {
94 "operationId": "run-sync-danielwebr-firebase-firestore-import",
95 "x-openai-isConsequential": false,
96 "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
97 "tags": [
98 "Run Actor"
99 ],
100 "requestBody": {
101 "required": true,
102 "content": {
103 "application/json": {
104 "schema": {
105 "$ref": "#/components/schemas/inputSchema"
106 }
107 }
108 }
109 },
110 "parameters": [
111 {
112 "name": "token",
113 "in": "query",
114 "required": true,
115 "schema": {
116 "type": "string"
117 },
118 "description": "Enter your Apify token here"
119 }
120 ],
121 "responses": {
122 "200": {
123 "description": "OK"
124 }
125 }
126 }
127 }
128 },
129 "components": {
130 "schemas": {
131 "inputSchema": {
132 "type": "object",
133 "required": [
134 "apiKey",
135 "authDomain",
136 "projectId",
137 "firestoreCollectionId",
138 "datasetId"
139 ],
140 "properties": {
141 "apiKey": {
142 "title": "API key to Firebase",
143 "type": "string",
144 "description": "Your API key to Firebase. It can be found in Firebase console under Project settings -> General -> Web API key."
145 },
146 "authDomain": {
147 "title": "Auth domain to Firebase",
148 "type": "string",
149 "description": "Your auth domain to Firebase. It can be found in Firebase console under Project settings -> Add app -> Web app -> Register app -> Code snippet -> authDomain."
150 },
151 "projectId": {
152 "title": "Project ID to Firebase",
153 "type": "string",
154 "description": "Your project ID to Firebase. It can be found in Firebase console under Project settings -> General -> Project ID."
155 },
156 "firestoreCollectionId": {
157 "title": "Firestore collection ID",
158 "type": "string",
159 "description": "Firestore collection ID to import data to. It can be found in Firebase console under Firestore Database -> Data. Ensure that the Firestore permissions are set to allow read and write. If the collection does not exist, it will be created."
160 },
161 "datasetId": {
162 "title": "Dataset ID in Apify to import data from",
163 "type": "string",
164 "description": "Dataset ID in Apify to import data from. It can be found in Apify console under Storage -> Datasets -> Dataset ID."
165 },
166 "customIdField": {
167 "title": "Custom ID field",
168 "type": "string",
169 "description": "Optional field name to use as a document ID in Firestore. If not provided, the document ID will be generated automatically. It is applied after the transform function. In case of duplicate IDs, the document will be overwritten. Read more in README."
170 },
171 "transformFunction": {
172 "title": "Transform function",
173 "type": "string",
174 "description": "Optional transform function to modify data before import. For more info see README."
175 }
176 }
177 },
178 "runsResponseSchema": {
179 "type": "object",
180 "properties": {
181 "data": {
182 "type": "object",
183 "properties": {
184 "id": {
185 "type": "string"
186 },
187 "actId": {
188 "type": "string"
189 },
190 "userId": {
191 "type": "string"
192 },
193 "startedAt": {
194 "type": "string",
195 "format": "date-time",
196 "example": "2025-01-08T00:00:00.000Z"
197 },
198 "finishedAt": {
199 "type": "string",
200 "format": "date-time",
201 "example": "2025-01-08T00:00:00.000Z"
202 },
203 "status": {
204 "type": "string",
205 "example": "READY"
206 },
207 "meta": {
208 "type": "object",
209 "properties": {
210 "origin": {
211 "type": "string",
212 "example": "API"
213 },
214 "userAgent": {
215 "type": "string"
216 }
217 }
218 },
219 "stats": {
220 "type": "object",
221 "properties": {
222 "inputBodyLen": {
223 "type": "integer",
224 "example": 2000
225 },
226 "rebootCount": {
227 "type": "integer",
228 "example": 0
229 },
230 "restartCount": {
231 "type": "integer",
232 "example": 0
233 },
234 "resurrectCount": {
235 "type": "integer",
236 "example": 0
237 },
238 "computeUnits": {
239 "type": "integer",
240 "example": 0
241 }
242 }
243 },
244 "options": {
245 "type": "object",
246 "properties": {
247 "build": {
248 "type": "string",
249 "example": "latest"
250 },
251 "timeoutSecs": {
252 "type": "integer",
253 "example": 300
254 },
255 "memoryMbytes": {
256 "type": "integer",
257 "example": 1024
258 },
259 "diskMbytes": {
260 "type": "integer",
261 "example": 2048
262 }
263 }
264 },
265 "buildId": {
266 "type": "string"
267 },
268 "defaultKeyValueStoreId": {
269 "type": "string"
270 },
271 "defaultDatasetId": {
272 "type": "string"
273 },
274 "defaultRequestQueueId": {
275 "type": "string"
276 },
277 "buildNumber": {
278 "type": "string",
279 "example": "1.0.0"
280 },
281 "containerUrl": {
282 "type": "string"
283 },
284 "usage": {
285 "type": "object",
286 "properties": {
287 "ACTOR_COMPUTE_UNITS": {
288 "type": "integer",
289 "example": 0
290 },
291 "DATASET_READS": {
292 "type": "integer",
293 "example": 0
294 },
295 "DATASET_WRITES": {
296 "type": "integer",
297 "example": 0
298 },
299 "KEY_VALUE_STORE_READS": {
300 "type": "integer",
301 "example": 0
302 },
303 "KEY_VALUE_STORE_WRITES": {
304 "type": "integer",
305 "example": 1
306 },
307 "KEY_VALUE_STORE_LISTS": {
308 "type": "integer",
309 "example": 0
310 },
311 "REQUEST_QUEUE_READS": {
312 "type": "integer",
313 "example": 0
314 },
315 "REQUEST_QUEUE_WRITES": {
316 "type": "integer",
317 "example": 0
318 },
319 "DATA_TRANSFER_INTERNAL_GBYTES": {
320 "type": "integer",
321 "example": 0
322 },
323 "DATA_TRANSFER_EXTERNAL_GBYTES": {
324 "type": "integer",
325 "example": 0
326 },
327 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
328 "type": "integer",
329 "example": 0
330 },
331 "PROXY_SERPS": {
332 "type": "integer",
333 "example": 0
334 }
335 }
336 },
337 "usageTotalUsd": {
338 "type": "number",
339 "example": 0.00005
340 },
341 "usageUsd": {
342 "type": "object",
343 "properties": {
344 "ACTOR_COMPUTE_UNITS": {
345 "type": "integer",
346 "example": 0
347 },
348 "DATASET_READS": {
349 "type": "integer",
350 "example": 0
351 },
352 "DATASET_WRITES": {
353 "type": "integer",
354 "example": 0
355 },
356 "KEY_VALUE_STORE_READS": {
357 "type": "integer",
358 "example": 0
359 },
360 "KEY_VALUE_STORE_WRITES": {
361 "type": "number",
362 "example": 0.00005
363 },
364 "KEY_VALUE_STORE_LISTS": {
365 "type": "integer",
366 "example": 0
367 },
368 "REQUEST_QUEUE_READS": {
369 "type": "integer",
370 "example": 0
371 },
372 "REQUEST_QUEUE_WRITES": {
373 "type": "integer",
374 "example": 0
375 },
376 "DATA_TRANSFER_INTERNAL_GBYTES": {
377 "type": "integer",
378 "example": 0
379 },
380 "DATA_TRANSFER_EXTERNAL_GBYTES": {
381 "type": "integer",
382 "example": 0
383 },
384 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
385 "type": "integer",
386 "example": 0
387 },
388 "PROXY_SERPS": {
389 "type": "integer",
390 "example": 0
391 }
392 }
393 }
394 }
395 }
396 }
397 }
398 }
399 }
400}Firebase Firestore Import OpenAPI definition
OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.
OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.
By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.
You can download the OpenAPI definitions for Firebase Firestore Import from the options below:
If you’d like to learn more about how OpenAPI powers GPTs, read our blog post.
You can also check out our other API clients:
Pricing
Pricing model
Pay per usageThis Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage.
