ThermoPhys API

Everything TP-Cloud does in the browser runs on an API, and we offer that same API to larger customers. If you want our thermodynamic models inside your own tools, your own workflows, or your own simulator, you do not have to go through the user interface. It is a REST API over HTTPS, so anything that can make an HTTP request can use it.

What is available

The API is documented at tpapi/docs as a Swagger UI. Note that this is only available for those with an API key. Those pages are generated from an OpenAPI specification, which you can also hand to a code generator to get a client in your own language instead of writing the requests yourself.

The API covers, among other things:

• Thermophysical properties. Every equation of state in the platform, for every component it covers. Densities, enthalpies, entropies, heat capacities, speed of sound and the rest of what the Property Calculator shows.
• Phase equilibria. Flash calculations and phase envelopes, the same ones behind Phase Diagrams.
• Transport and interfacial properties. Viscosity and thermal conductivity, and surface tension.
• Flow assurance. Solid and hydrate stability, the same checks as the Global Safety Scan.
• Process simulation. Submit a flowsheet and get the solved result back.

The interface follows the same conventions as the one used by OLGA, so if you have integrated a property server before, this will look familiar.

Getting access

The API is part of a commercial agreement, instead of something a user can enable themselves. Get in touch, and we can issue you an API key. You send that key with each request, and usage is tracked per key.