1
0
mirror of https://github.com/oceanprotocol/docs.git synced 2024-11-02 00:05:35 +01:00
docs/content/references/introduction.md

21 lines
928 B
Markdown
Raw Normal View History

2018-11-23 15:08:58 +01:00
---
2019-04-17 12:58:02 +02:00
title: API References
2020-11-14 00:43:06 +01:00
description:
2018-11-23 15:08:58 +01:00
---
2019-04-17 12:58:02 +02:00
This section has API reference docs (or links to external ones) for the following Ocean Protocol components and libraries:
2018-11-23 15:08:58 +01:00
<repo name="ocean.js"></repo>
2020-11-14 00:43:06 +01:00
<repo name="aquarius"></repo>
<repo name="provider"></repo>
2020-10-25 15:21:43 +01:00
<repo name="react"></repo>
<repo name="ocean.py"></repo>
2020-12-03 19:00:36 +01:00
<repo name="contracts"></repo>
2018-11-23 15:08:58 +01:00
2020-11-14 00:43:06 +01:00
The API references for Aquarius and Provider are auto-generated from the Swagger specs (JSON files) of the live instances. On this site you can't execute the documented API calls yet. If you need that, you can run a component's local Swagger UI as outlined in the repository instructions on GitHub.
2020-12-03 19:00:36 +01:00
2020-11-14 00:43:06 +01:00
Additionally, if you need API docs for a past version of Aquarius or Provider, check out their specs on SwaggerHub:
2019-04-17 13:09:36 +02:00
- [SwaggerHub: Aquarius](https://app.swaggerhub.com/apis/Ocean-Protocol/aquarius)
2020-11-14 00:43:06 +01:00
- [SwaggerHub: Provider](https://app.swaggerhub.com/apis/Ocean-Protocol/provider)