External libraries

We’re currently maintaining two external libraries auto-generated from our OpenAPI specification file (opens new window) using openapi-generator (opens new window).

Typescript

• Install via NPM:

npm install @bimdata/typescript-fetch-api-client --save

• URL: https://www.npmjs.com/package/@bimdata/typescript-fetch-api-client (opens new window)

• Repository: https://github.com/bimdata/typescript-fetch-api-client-generator (opens new window)

Note: the typescript-fetch-api-client can be used in JavaScript & TypeScript codebase the same way.

Python

• URL: https://pypi.org/project/bimdata-api-client/ (opens new window)

• Repository: https://github.com/bimdata/python-api-client (opens new window)

IMPORTANT

Requirements: Python 2.7 and 3.4+

Generate your own

We offer our OpenAPI file to let you use it. You can use one of those generators to get a client in your favorite programmation language: https://openapi-generator.tech/docs/generators (opens new window)

1. Install OpenAPI Generator following their documentation (opens new window).

2. With a local version (or not) of our OpenAPI file, generate your client with openapi-generator generate options depending on your install.

3. Add your new API client in your software stack, everything is in the README generated along with your client.

4. Use it and check our API Reference documentation.