Thingspeak
==========



The ThingSpeak Service provides access to the ThingSpeak IoT analytics platform.
For more information, check out https://thingspeak.com/.

Terms of use: https://thingspeak.com/pages/terms



.. toctree::
    :maxdepth: 2
    :titlesonly:
    :caption: RPC Categories





RPCS
----

.. function:: Thingspeak.channelDetails(id: Number)

    Get various details about the channel, including location, fields, tags and name.

    **Arguments:**

    - ``id: Number`` (`Number </docs/fundamentals/rpc-arg-types.html#Number>`__) - channel ID

    **Returns:** ``Object`` (`Object </docs/fundamentals/rpc-arg-types.html#Object>`__) - Channel details.


.. function:: Thingspeak.channelFeed(id: String, numResult: Number)

    Get channel feed.

    **Arguments:**

    - ``id: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) 
    - ``numResult: Number`` (`Number </docs/fundamentals/rpc-arg-types.html#Number>`__) 


.. function:: Thingspeak.privateChannelFeed(id: String, numResult: Number, apiKey: String)

    Request data from a private channel

    **Arguments:**

    - ``id: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) - ID of the private channel feed
    - ``numResult: Number`` (`Number </docs/fundamentals/rpc-arg-types.html#Number>`__) - Number of results to fetch
    - ``apiKey: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) - Thingspeak API key


.. function:: Thingspeak.searchByLocation(latitude: Latitude, longitude: Longitude, distance: BoundedNumber<0>?, limit: Number?, updatedSince: Date?)

    Search for channels by location.

    **Arguments:**

    - ``latitude: Latitude`` (`Latitude </docs/fundamentals/rpc-arg-types.html#Latitude>`__) - latitude to search near
    - ``longitude: Longitude`` (`Longitude </docs/fundamentals/rpc-arg-types.html#Longitude>`__) - longitude to search near
    - ``distance: BoundedNumber<0>?`` (`BoundedNumber </docs/fundamentals/rpc-arg-types.html#BoundedNumber>`__) - max distance from location in meters (default ``100000`` = 100Km)
    - ``limit: Number?`` (`Number </docs/fundamentals/rpc-arg-types.html#Number>`__) - max number of results to return (default ``15``)
    - ``updatedSince: Date?`` (`Date </docs/fundamentals/rpc-arg-types.html#Date>`__) - only include results which have (some) new data since this date (default no time-based filtering)

    **Returns:** ``List<Object>`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__ | `Object </docs/fundamentals/rpc-arg-types.html#Object>`__) - search results


.. function:: Thingspeak.searchByTag(tag: String, limit: Number?, updatedSince: Date?)

    Search for ThingSpeak channels by tag.

    **Arguments:**

    - ``tag: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) - tag to search for
    - ``limit: Number?`` (`Number </docs/fundamentals/rpc-arg-types.html#Number>`__) - max number of results to return (default ``15``)
    - ``updatedSince: Date?`` (`Date </docs/fundamentals/rpc-arg-types.html#Date>`__) - only include results which have (some) new data since this date (default no time-based filtering)

    **Returns:** ``List<Object>`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__ | `Object </docs/fundamentals/rpc-arg-types.html#Object>`__) - search results


.. function:: Thingspeak.searchByTagAndLocation(tag: String, latitude: Latitude, longitude: Longitude, distance: BoundedNumber<0>?, limit: Number?, updatedSince: Date?)

    Search for channels by tag and location.

    **Arguments:**

    - ``tag: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) - tag to search for
    - ``latitude: Latitude`` (`Latitude </docs/fundamentals/rpc-arg-types.html#Latitude>`__) - latitude to search near
    - ``longitude: Longitude`` (`Longitude </docs/fundamentals/rpc-arg-types.html#Longitude>`__) - longitude to search near
    - ``distance: BoundedNumber<0>?`` (`BoundedNumber </docs/fundamentals/rpc-arg-types.html#BoundedNumber>`__) - max distance from location in meters (default ``100000`` = 100Km)
    - ``limit: Number?`` (`Number </docs/fundamentals/rpc-arg-types.html#Number>`__) - max number of results to return (default ``15``)
    - ``updatedSince: Date?`` (`Date </docs/fundamentals/rpc-arg-types.html#Date>`__) - only include results which have (some) new data since this date (default no time-based filtering)

    **Returns:** ``List<Object>`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__ | `Object </docs/fundamentals/rpc-arg-types.html#Object>`__) - search results