InfluxDB client libraries

InfluxDB client libraries are language-specific packages that integrate with InfluxDB APIs and support InfluxDB 1.8+ and InfluxDB 2.x.

Client libraries for InfluxDB 2.x and 1.8+

InfluxDB 2.x client libraries use InfluxDB /api/v2 endpoints and work with InfluxDB 2.0 API compatibility endpoints. Functionality varies among client libraries. For specifics about a client library, see the library’s GitHub repository.

Arduino

• InfluxDB Arduino Client
  • Contributed by Tobias Schürg (tobiasschuerg)

C#

• influxdb-client-csharp
  • Maintained by InfluxData

C++

• influxdb-cxx
  • Maintained by offa

Go

• influxdb-client-go
  • Maintained by InfluxData

Java

• influxdb-client-java
  • Maintained by InfluxData

JavaScript

• influxdb-javascript
  • Maintained by InfluxData

PHP

• influxdb-client-php
  • Maintained by InfluxData

Python

• influxdb-client-python
  • Maintained by InfluxData

Ruby

• influxdb-client-ruby
  • Maintained by InfluxData

Install and use a client library

To install and use the Python client library, follow the instructions below. To install and use other client libraries, refer to the client library documentation for detail.

Install and use the Python client library

1. Install the Python client library.

   pip install influxdb-client
   

   • Copy
   • Fill window

2. Ensure that InfluxDB is running. If running InfluxDB locally, visit http://localhost:8086. (If using InfluxDB Cloud, visit the URL of your InfluxDB Cloud UI.)

3. In your program, import the client library and use it to write data to InfluxDB. For example:

   import influxdb_client
   from influxdb_client.client.write_api import SYNCHRONOUS
   

   • Copy
   • Fill window

4. Define your database and token variables, and create a client and writer object. The InfluxDBClient object takes 2 parameters: url and token

   database = "<my-db>"
   token = "<my-token>"
   client = influxdb_client.InfluxDBClient(url="http://localhost:8086",token=token)
   

   Change InfluxDB URL

   • Copy
   • Fill window

   Note: The database (and retention policy, if applicable) are converted to a bucket data store compatible with InfluxDB 2.0.

5. Instantiate a writer object using the client object and the write_api method. Use the write_api method to configure the writer object.

   client = influxdb_client.InfluxDBClient(url=url, token=token)
   write_api = client.write_api(write_options=SYNCHRONOUS)
   

   • Copy
   • Fill window

6. Create a point object and write it to InfluxDB using the write method of the API writer object. The write method requires three parameters: database, (optional) retention policy, and record.

   p = influxdb_client.Point("my_measurement").tag("location", "Prague").field("temperature", 25.3)
   write_api.write(database:rp, record=p)
   

   • Copy
   • Fill window