{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources. Success responses include a `source` block to cite. Apizie Finance endpoints (SEC EDGAR, FRED, ECB, U.S. Treasury, GLEIF, World Bank, official:*) need a Finance plan."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/analytics:googleapis-cloudiot/cloudiot-projects-locations-registries-bind-device-to-gatewa":{"post":{"operationId":"analytics_googleapis_cloudiot_cloudiot_projects_locations_registries_bind_device_to_gatewa","summary":"Associates the device with the gateway.","description":"POST /v1/{+parent}:bindDeviceToGateway","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["parent","body"],"properties":{"parent":{"type":"string","description":"Required. The name of the registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-cloudiot/cloudiot-projects-locations-registries-list":{"get":{"operationId":"analytics_googleapis_cloudiot_cloudiot_projects_locations_registries_list","summary":"Lists device registries.","description":"GET /v1/{+parent}/registries","tags":["analytics"],"x-apizie-access":"read","parameters":[{"name":"pageSize","in":"query","required":false,"description":"The maximum number of registries to return in the response. If this value is zero, the service will select a default size. A call may…","schema":{"type":"integer","description":"The maximum number of registries to return in the response. If this value is zero, the service will select a default size. A call may…"}},{"name":"pageToken","in":"query","required":false,"description":"The value returned by the last `ListDeviceRegistriesResponse`; indicates that this is a continuation of a prior `ListDeviceRegistries`…","schema":{"type":"string","description":"The value returned by the last `ListDeviceRegistriesResponse`; indicates that this is a continuation of a prior `ListDeviceRegistries`…"}},{"name":"parent","in":"query","required":true,"description":"Required. The project and cloud region path. For example, `projects/example-project/locations/us-central1`.","schema":{"type":"string","description":"Required. The project and cloud region path. For example, `projects/example-project/locations/us-central1`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-cloudiot/cloudiot-projects-locations-registries-create":{"post":{"operationId":"analytics_googleapis_cloudiot_cloudiot_projects_locations_registries_create","summary":"Creates a device registry that contains devices.","description":"POST /v1/{+parent}/registries","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["parent","body"],"properties":{"parent":{"type":"string","description":"Required. The project and cloud region where this device registry must be created. For example,…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-cloudiot/cloudiot-projects-locations-registries-devices-get":{"get":{"operationId":"analytics_googleapis_cloudiot_cloudiot_projects_locations_registries_devices_get","summary":"Gets details about a device.","description":"GET /v1/{+name}","tags":["analytics"],"x-apizie-access":"read","parameters":[{"name":"fieldMask","in":"query","required":false,"description":"The fields of the `Device` resource to be returned in the response. If the field mask is unset or empty, all fields are returned. Fields…","schema":{"type":"string","description":"The fields of the `Device` resource to be returned in the response. If the field mask is unset or empty, all fields are returned. Fields…"}},{"name":"name","in":"query","required":true,"description":"Required. The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or…","schema":{"type":"string","description":"Required. The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-cloudiot/cloudiot-projects-locations-registries-devices-patch":{"post":{"operationId":"analytics_googleapis_cloudiot_cloudiot_projects_locations_registries_devices_patch","summary":"Updates a device.","description":"PATCH /v1/{+name}","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","body"],"properties":{"name":{"type":"string","description":"The resource path name. For example, `projects/p1/locations/us-central1/registries/registry0/devices/dev0` or…"},"updateMask":{"type":"string","description":"Required. Only updates the `device` fields indicated by this mask. The field mask must not be empty, and it must not contain fields that…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-cloudiot/cloudiot-projects-locations-registries-devices-delete":{"post":{"operationId":"analytics_googleapis_cloudiot_cloudiot_projects_locations_registries_devices_delete","summary":"Deletes a device.","description":"DELETE /v1/{+name}","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Required. The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-cloudiot/cloudiot-projects-locations-registries-groups-get-iam-policy":{"post":{"operationId":"analytics_googleapis_cloudiot_cloudiot_projects_locations_registries_groups_get_iam_policy","summary":"Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not…","description":"POST /v1/{+resource}:getIamPolicy","tags":["analytics"],"x-apizie-access":"read","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["resource","body"],"properties":{"resource":{"type":"string","description":"REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names)…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-cloudiot/cloudiot-projects-locations-registries-groups-set-iam-policy":{"post":{"operationId":"analytics_googleapis_cloudiot_cloudiot_projects_locations_registries_groups_set_iam_policy","summary":"Sets the access control policy on the specified resource. Replaces any existing policy.","description":"POST /v1/{+resource}:setIamPolicy","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["resource","body"],"properties":{"resource":{"type":"string","description":"REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names)…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-cloudiot/cloudiot-projects-locations-registries-groups-test-iam-permi":{"post":{"operationId":"analytics_googleapis_cloudiot_cloudiot_projects_locations_registries_groups_test_iam_permi","summary":"Returns permissions that a caller has on the specified resource. If the resource does not exist, this will…","description":"POST /v1/{+resource}:testIamPermissions","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["resource","body"],"properties":{"resource":{"type":"string","description":"REQUIRED: The resource for which the policy detail is being requested. See [Resource…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-cloudiot/cloudiot-projects-locations-registries-unbind-device-from-ga":{"post":{"operationId":"analytics_googleapis_cloudiot_cloudiot_projects_locations_registries_unbind_device_from_ga","summary":"Deletes the association between the device and the gateway.","description":"POST /v1/{+parent}:unbindDeviceFromGateway","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["parent","body"],"properties":{"parent":{"type":"string","description":"Required. The name of the registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-cloudiot/cloudiot-projects-locations-registries-groups-devices-list":{"get":{"operationId":"analytics_googleapis_cloudiot_cloudiot_projects_locations_registries_groups_devices_list","summary":"List devices in a device registry.","description":"GET /v1/{+parent}/devices","tags":["analytics"],"x-apizie-access":"read","parameters":[{"name":"deviceIds","in":"query","required":false,"description":"A list of device string IDs. For example, `['device0', 'device12']`. If empty, this field is ignored. Maximum IDs: 10,000","schema":{"type":"string","description":"A list of device string IDs. For example, `['device0', 'device12']`. If empty, this field is ignored. Maximum IDs: 10,000"}},{"name":"deviceNumIds","in":"query","required":false,"description":"A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.","schema":{"type":"string","description":"A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000."}},{"name":"fieldMask","in":"query","required":false,"description":"The fields of the `Device` resource to be returned in the response. The fields `id` and `num_id` are always returned, along with any other…","schema":{"type":"string","description":"The fields of the `Device` resource to be returned in the response. The fields `id` and `num_id` are always returned, along with any other…"}},{"name":"gatewayListOptions.associationsDeviceId","in":"query","required":false,"description":"If set, returns only the gateways with which the specified device is associated. The device ID can be numeric (`num_id`) or the…","schema":{"type":"string","description":"If set, returns only the gateways with which the specified device is associated. The device ID can be numeric (`num_id`) or the…"}},{"name":"gatewayListOptions.associationsGatewayId","in":"query","required":false,"description":"If set, only devices associated with the specified gateway are returned. The gateway ID can be numeric (`num_id`) or the user-defined…","schema":{"type":"string","description":"If set, only devices associated with the specified gateway are returned. The gateway ID can be numeric (`num_id`) or the user-defined…"}},{"name":"gatewayListOptions.gatewayType","in":"query","required":false,"description":"If `GATEWAY` is specified, only gateways are returned. If `NON_GATEWAY` is specified, only non-gateway devices are returned. If…","schema":{"type":"string","enum":["GATEWAY_TYPE_UNSPECIFIED","GATEWAY","NON_GATEWAY"],"description":"If `GATEWAY` is specified, only gateways are returned. If `NON_GATEWAY` is specified, only non-gateway devices are returned. If…"}},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of devices to return in the response. If this value is zero, the service will select a default size. A call may return…","schema":{"type":"integer","description":"The maximum number of devices to return in the response. If this value is zero, the service will select a default size. A call may return…"}},{"name":"pageToken","in":"query","required":false,"description":"The value returned by the last `ListDevicesResponse`; indicates that this is a continuation of a prior `ListDevices` call and the system…","schema":{"type":"string","description":"The value returned by the last `ListDevicesResponse`; indicates that this is a continuation of a prior `ListDevices` call and the system…"}},{"name":"parent","in":"query","required":true,"description":"Required. The device registry path. Required. For example, `projects/my-project/locations/us-central1/registries/my-registry`.","schema":{"type":"string","description":"Required. The device registry path. Required. For example, `projects/my-project/locations/us-central1/registries/my-registry`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-cloudiot/cloudiot-projects-locations-registries-devices-create":{"post":{"operationId":"analytics_googleapis_cloudiot_cloudiot_projects_locations_registries_devices_create","summary":"Creates a device in a device registry.","description":"POST /v1/{+parent}/devices","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["parent","body"],"properties":{"parent":{"type":"string","description":"Required. The name of the device registry where this device should be created. For example,…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-cloudiot/cloudiot-projects-locations-registries-devices-modify-cloud":{"post":{"operationId":"analytics_googleapis_cloudiot_cloudiot_projects_locations_registries_devices_modify_cloud","summary":"Modifies the configuration for the device, which is eventually sent from the Cloud IoT Core servers. Returns…","description":"POST /v1/{+name}:modifyCloudToDeviceConfig","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","body"],"properties":{"name":{"type":"string","description":"Required. The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-cloudiot/cloudiot-projects-locations-registries-devices-send-command":{"post":{"operationId":"analytics_googleapis_cloudiot_cloudiot_projects_locations_registries_devices_send_command","summary":"Sends a command to the specified device. In order for a device to be able to receive commands, it must: 1)…","description":"POST /v1/{+name}:sendCommandToDevice","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","body"],"properties":{"name":{"type":"string","description":"Required. The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-cloudiot/cloudiot-projects-locations-registries-devices-config-versio":{"get":{"operationId":"analytics_googleapis_cloudiot_cloudiot_projects_locations_registries_devices_config_versio","summary":"Lists the last few versions of the device configuration in descending order (i.e.: newest first).","description":"GET /v1/{+name}/configVersions","tags":["analytics"],"x-apizie-access":"read","parameters":[{"name":"name","in":"query","required":true,"description":"Required. The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or…","schema":{"type":"string","description":"Required. The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or…"}},{"name":"numVersions","in":"query","required":false,"description":"The number of versions to list. Versions are listed in decreasing order of the version number. The maximum number of versions retained is…","schema":{"type":"integer","description":"The number of versions to list. Versions are listed in decreasing order of the version number. The maximum number of versions retained is…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-cloudiot/cloudiot-projects-locations-registries-devices-states-list":{"get":{"operationId":"analytics_googleapis_cloudiot_cloudiot_projects_locations_registries_devices_states_list","summary":"Lists the last few versions of the device state in descending order (i.e.: newest first).","description":"GET /v1/{+name}/states","tags":["analytics"],"x-apizie-access":"read","parameters":[{"name":"name","in":"query","required":true,"description":"Required. The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or…","schema":{"type":"string","description":"Required. The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or…"}},{"name":"numStates","in":"query","required":false,"description":"The number of states to list. States are listed in descending order of update time. The maximum number of states retained is 10. If this…","schema":{"type":"integer","description":"The number of states to list. States are listed in descending order of update time. The maximum number of states retained is 10. If this…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"official:company"},"data":{},"source":{"type":"object","description":"Where the data came from. Cite it.","properties":{"official":{"type":"boolean"},"provider":{"type":"string","example":"SEC EDGAR"},"publisher":{"type":"string","example":"U.S. Securities and Exchange Commission"},"url":{"type":"string","format":"uri","description":"A page a person can open to check the value"},"apiUrl":{"type":"string","format":"uri","description":"The official API URL that was called (credentials removed)"},"retrievedAt":{"type":"string","format":"date-time"},"license":{"type":"string"},"licenseUrl":{"type":"string","format":"uri"},"attribution":{"type":"string"},"notice":{"type":"string"}}},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}