API Client Libraries
data.world maintains implementations of API libraries in Python and R.
In addition, libraries can be automatically generated for many more languages using the Swagger Codegen tool, including: ActionScript, Apex, Bash, C#, C++, Clojure, Dart, Elixir, Eiffel, Go, Groovy, Haskell, Java, Kotlin, Node.js, Objective-C, Perl, PHP, PowerShell, Ruby, Scala, Swift and Typescript.
You can install it using pip directly from PyPI:
pip install datadotworld
Optionally, you can install the library including pandas support:
pip install datadotworld[pandas]
If you use conda to manage your python distribution, you can install from the community-maintained conda-forge channel:
conda install -c conda-forge datadotworld-py
For additional information and usage instructions, visit https://github.com/datadotworld/data.world-py
To get the current released version from CRAN:
To get the current development version from GitHub:
devtools::install_github("datadotworld/data.world-r", build_vignettes = TRUE)
For additional information and usage instructions, visit https://github.com/datadotworld/data.world-r
What is Swagger?
Swagger is a set of open-source tools built around the OpenAPI Specification that can help you design, build, document and consume REST APIs.
The OpenAPI Specification (formerly Swagger Specification) is an API description format for REST APIs. An OpenAPI file allows you to describe your entire API, including:
- Available endpoints (
/users) and operations on each endpoint (
- Operation parameters (input and output) for each operation
- Authentication methods
API specifications can be written in YAML or JSON. The format is easy to learn and is both human-readable and machine-readable.
data.world’s public API specification is available at https://api.data.world/v0/swagger.json
The complete OpenAPI Specification can be found on GitHub: OpenAPI 2.0 Specification
If you’re looking for the latest stable version, you can grab it directly from Maven.org (Java 7 runtime at a minimum):
wget http://central.maven.org/maven2/io/swagger/swagger-codegen-cli/2.2.3/swagger-codegen-cli-2.2.3.jar -O swagger-codegen-cli.jar java -jar swagger-codegen-cli.jar help
On a mac, it’s even easier with
brew install swagger-codegen
To build from source, you need the following installed and available in your $PATH:
Here is an example usage (assuming tool was installed with Homebrew):
swagger-codegen generate -i https://api.data.world/v0/swagger.json -l ruby -o /dw-api-ruby
For additional information, visit: https://swagger.io/swagger-codegen/