find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/particle-events-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Particle Cloud Events API
  description: The Particle Cloud REST API enables developers to interact with Particle-connected devices — calling device functions, reading variables, publishing and subscribing to events, managing SIM cards, performing OTA firmware updates, and administering product fleets. All requests use OAuth 2.0 bearer tokens and target https://api.particle.io.
  version: 1.0.0
  contact:
    name: Particle Developer Support
    url: https://docs.particle.io/reference/cloud-apis/api/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://api.particle.io
  description: Particle Cloud API
security:
- bearerAuth: []
tags:
- name: Events
paths:
  /v1/events/{eventPrefix}:
    get:
      summary: Get a stream of events
      operationId: GetEvents
      tags:
      - Events
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
      description: Open a stream of Server Sent Events for all events. for your devices matching the filter. Note that as of April 2018, the event prefix filter is required. It was optional before.
      parameters:
      - name: eventPrefix
        in: path
        required: true
        schema:
          type: string
  /v1/devices/events/{eventPrefix}:
    get:
      summary: Get a stream of your events
      operationId: GetDeviceEvents
      tags:
      - Events
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
      description: Open a stream of Server Sent Events for all events for your devices.
      parameters:
      - name: eventPrefix
        in: path
        required: true
        schema:
          type: string
  /v1/devices/{deviceId}/events/{eventPrefix}:
    get:
      summary: Get a stream of events for a device
      operationId: GetDeviceEvents
      tags:
      - Events
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
      description: Open a stream of Server Sent Events for all events for the specified device.
      parameters:
      - name: deviceId
        in: path
        required: true
        schema:
          type: string
      - name: eventPrefix
        in: path
        required: true
        schema:
          type: string
  /v1/products/{productIdOrSlug}/events/{eventPrefix}:
    get:
      summary: Product event stream
      operationId: GetProductEvents
      tags:
      - Events
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
      description: Open a stream of Server Sent Events for all events for a product.
      parameters:
      - name: productIdOrSlug
        in: path
        required: true
        schema:
          type: string
      - name: eventPrefix
        in: path
        required: true
        schema:
          type: string
  /v1/devices/events:
    post:
      summary: Publish an event
      operationId: CreateEvent
      tags:
      - Events
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
  /v1/products/{productIdOrSlug}/events:
    post:
      summary: Publish a product event
      operationId: PublishProductEvent
      tags:
      - Events
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
      description: Publish an event that is sent to the product's event stream
      parameters:
      - name: productIdOrSlug
        in: path
        required: true
        schema:
          type: string
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: OAuth 2.0 bearer token. Obtain via POST /oauth/token.
externalDocs:
  description: Particle Cloud API Reference
  url: https://docs.particle.io/reference/cloud-apis/api/