From 10b49e3f5a16e779fde18537aea1249084e4a97c Mon Sep 17 00:00:00 2001 From: Forrest Norwood Date: Tue, 18 Jul 2023 13:46:50 -0500 Subject: [PATCH 1/3] create root api page --- pages/api-guides/_meta.en.json | 1 + pages/api-guides/_meta.json | 1 + pages/api-guides/api-overview.en.mdx | 34 ++++++++++++++++++++++++++++ pages/api-guides/api-overview.mdx | 0 4 files changed, 36 insertions(+) create mode 100644 pages/api-guides/api-overview.en.mdx create mode 100644 pages/api-guides/api-overview.mdx diff --git a/pages/api-guides/_meta.en.json b/pages/api-guides/_meta.en.json index 609da16..cc9348b 100644 --- a/pages/api-guides/_meta.en.json +++ b/pages/api-guides/_meta.en.json @@ -1,4 +1,5 @@ { + "api-overview": "Overview", "orders": "Orders", "subgraphs": "Subgraphs", "rubi-py": "Python SDK" diff --git a/pages/api-guides/_meta.json b/pages/api-guides/_meta.json index 609da16..cc9348b 100644 --- a/pages/api-guides/_meta.json +++ b/pages/api-guides/_meta.json @@ -1,4 +1,5 @@ { + "api-overview": "Overview", "orders": "Orders", "subgraphs": "Subgraphs", "rubi-py": "Python SDK" diff --git a/pages/api-guides/api-overview.en.mdx b/pages/api-guides/api-overview.en.mdx new file mode 100644 index 0000000..f0a4f1d --- /dev/null +++ b/pages/api-guides/api-overview.en.mdx @@ -0,0 +1,34 @@ +--- +title: Overview +pageTitle: API Overview +description: Overview of Rubicon APIs/SDKs +--- + +# Rubicon APIs + +Rubicon has several APIs for interacting with and trading on the protocol. While you can always interact directly with the [Rubicon smart contracts](/protocol/deployments), the APIs provide convenient ways to query data and interact with the protocol using different tooling. + +## Hosted API + +Rubicon provides a... + +## Subgraphs + +Rubicon has multiple subgraphs for indexing and organizing data from the smart contracts. Rubicon subgraphs are currently on The Graph's Hosted Service and will soon be migrated to the Decentralized Network. + +[Subgraphs Github Repo](https://github.com/RubiconDeFi/rubi-subgraphs/) + +### Deployments + +| Subgraph | Network | Explorer Page | GraphQL Endpoint | +|---------------------|----------------|----------------------------------------------------------------------------------------------|---------------------------------------------------------------------------| +| RubiconV2_Optimism | `Optimism` | [Link](https://api.thegraph.com/subgraphs/name/denverbaumgartner/rubiconv2-optimism-mainnet) | https://api.rubicon.finance/subgraphs/name/RubiconV2_Optimism_Mainnet_Dev | +| RubiconV2 | `Arbitrum One` | [Link](https://api.thegraph.com/subgraphs/name/denverbaumgartner/rubiconv2-arbitrum-one) | https://api.rubicon.finance/subgraphs/name/RubiconV2_Arbitrum_One | + +## Python SDK + +A Python library for interacting with Rubicon. + +- [SDK Docs](https://rubi.readthedocs.io/en/latest/) +- [Python SDK Package](https://pypi.org/project/rubi/) +- [Python SDK Github Repo](https://github.com/RubiconDeFi/rubi-py) diff --git a/pages/api-guides/api-overview.mdx b/pages/api-guides/api-overview.mdx new file mode 100644 index 0000000..e69de29 From de5934a4c376e5b5cd3b1c2c43675db9e7b41d9a Mon Sep 17 00:00:00 2001 From: denver Date: Tue, 18 Jul 2023 17:25:02 -0400 Subject: [PATCH 2/3] update: api overview --- pages/api-guides/api-overview.en.mdx | 27 +++++++++++--------- pages/api-guides/api-overview.mdx | 37 ++++++++++++++++++++++++++++ 2 files changed, 52 insertions(+), 12 deletions(-) diff --git a/pages/api-guides/api-overview.en.mdx b/pages/api-guides/api-overview.en.mdx index f0a4f1d..0625605 100644 --- a/pages/api-guides/api-overview.en.mdx +++ b/pages/api-guides/api-overview.en.mdx @@ -4,30 +4,33 @@ pageTitle: API Overview description: Overview of Rubicon APIs/SDKs --- +import { Callout } from "/components/Callout"; + # Rubicon APIs -Rubicon has several APIs for interacting with and trading on the protocol. While you can always interact directly with the [Rubicon smart contracts](/protocol/deployments), the APIs provide convenient ways to query data and interact with the protocol using different tooling. +Rubicon has several APIs for retrieving data regarding the protocol. While you can always interact directly with the [Rubicon smart contracts](/protocol/deployments) to get data regarding current chain state, the APIs provide a convenient way to query both current and historical data from the protocol, solving the problems typically associated with blockchain data retrieval. The APIs are powered by [The Graph](https://thegraph.com/), and you can learn more about them in our [Subgraphs](/api-guides/subgraphs/subgraphs) section. ## Hosted API -Rubicon provides a... - -## Subgraphs +Rubicon provides a hosted API for retrieving data regarding the protocol. This API is free of charge to all user's, and aims to provide the most up-to-date information regarding the protocol. In addition to Rubicon's hosted API, users can also access data through [The Graph's Hosted Service](https://thegraph.com/hosted-service), which serves as a backup to Rubicon's own hosted hardware. Soon, Rubicon will migrate its API to the [decentralized network](https://thegraph.com/explorer), where users can expect even greater reliability and performance. -Rubicon has multiple subgraphs for indexing and organizing data from the smart contracts. Rubicon subgraphs are currently on The Graph's Hosted Service and will soon be migrated to the Decentralized Network. - -[Subgraphs Github Repo](https://github.com/RubiconDeFi/rubi-subgraphs/) ### Deployments + + Each network has its own API endpoint. Be sure to use the correct endpoint for the network you are querying. + + -| Subgraph | Network | Explorer Page | GraphQL Endpoint | -|---------------------|----------------|----------------------------------------------------------------------------------------------|---------------------------------------------------------------------------| -| RubiconV2_Optimism | `Optimism` | [Link](https://api.thegraph.com/subgraphs/name/denverbaumgartner/rubiconv2-optimism-mainnet) | https://api.rubicon.finance/subgraphs/name/RubiconV2_Optimism_Mainnet_Dev | -| RubiconV2 | `Arbitrum One` | [Link](https://api.thegraph.com/subgraphs/name/denverbaumgartner/rubiconv2-arbitrum-one) | https://api.rubicon.finance/subgraphs/name/RubiconV2_Arbitrum_One | +| Network | Explorer Page | GraphQL Endpoint | +|-------------------|----------------------------------------------------------------------------------------------|---------------------------------------------------------------------------| +| `Optimism` | [Link](https://api.thegraph.com/subgraphs/name/denverbaumgartner/rubiconv2-optimism-mainnet) | https://api.rubicon.finance/subgraphs/name/RubiconV2_Optimism_Mainnet_Dev | +| `Arbitrum One` | [Link](https://api.thegraph.com/subgraphs/name/denverbaumgartner/rubiconv2-arbitrum-one) | https://api.rubicon.finance/subgraphs/name/RubiconV2_Arbitrum_One | +| `Optimism Goerli` | [Link](https://api.thegraph.com/subgraphs/name/denverbaumgartner/rubiconv2-optimism-goerli) | https://api.rubicon.finance/subgraphs/name/RubiconV2_Optimism_Goerli | +| `Arbitrum Goerli` | [Link](https://api.thegraph.com/subgraphs/name/denverbaumgartner/rubiconv2-arbitrum-goerli) | https://api.rubicon.finance/subgraphs/name/RubiconV2_Arbitrum_Goerli | ## Python SDK -A Python library for interacting with Rubicon. +A Python library for interacting with Rubicon. Contains a growing list of utility functions for retrieving and formatting data from the Rubicon API. The SDK is open source and available on [Github](https://github.com/RubiconDeFi/rubi-py). - [SDK Docs](https://rubi.readthedocs.io/en/latest/) - [Python SDK Package](https://pypi.org/project/rubi/) diff --git a/pages/api-guides/api-overview.mdx b/pages/api-guides/api-overview.mdx index e69de29..0625605 100644 --- a/pages/api-guides/api-overview.mdx +++ b/pages/api-guides/api-overview.mdx @@ -0,0 +1,37 @@ +--- +title: Overview +pageTitle: API Overview +description: Overview of Rubicon APIs/SDKs +--- + +import { Callout } from "/components/Callout"; + +# Rubicon APIs + +Rubicon has several APIs for retrieving data regarding the protocol. While you can always interact directly with the [Rubicon smart contracts](/protocol/deployments) to get data regarding current chain state, the APIs provide a convenient way to query both current and historical data from the protocol, solving the problems typically associated with blockchain data retrieval. The APIs are powered by [The Graph](https://thegraph.com/), and you can learn more about them in our [Subgraphs](/api-guides/subgraphs/subgraphs) section. + +## Hosted API + +Rubicon provides a hosted API for retrieving data regarding the protocol. This API is free of charge to all user's, and aims to provide the most up-to-date information regarding the protocol. In addition to Rubicon's hosted API, users can also access data through [The Graph's Hosted Service](https://thegraph.com/hosted-service), which serves as a backup to Rubicon's own hosted hardware. Soon, Rubicon will migrate its API to the [decentralized network](https://thegraph.com/explorer), where users can expect even greater reliability and performance. + + +### Deployments + + Each network has its own API endpoint. Be sure to use the correct endpoint for the network you are querying. + + + +| Network | Explorer Page | GraphQL Endpoint | +|-------------------|----------------------------------------------------------------------------------------------|---------------------------------------------------------------------------| +| `Optimism` | [Link](https://api.thegraph.com/subgraphs/name/denverbaumgartner/rubiconv2-optimism-mainnet) | https://api.rubicon.finance/subgraphs/name/RubiconV2_Optimism_Mainnet_Dev | +| `Arbitrum One` | [Link](https://api.thegraph.com/subgraphs/name/denverbaumgartner/rubiconv2-arbitrum-one) | https://api.rubicon.finance/subgraphs/name/RubiconV2_Arbitrum_One | +| `Optimism Goerli` | [Link](https://api.thegraph.com/subgraphs/name/denverbaumgartner/rubiconv2-optimism-goerli) | https://api.rubicon.finance/subgraphs/name/RubiconV2_Optimism_Goerli | +| `Arbitrum Goerli` | [Link](https://api.thegraph.com/subgraphs/name/denverbaumgartner/rubiconv2-arbitrum-goerli) | https://api.rubicon.finance/subgraphs/name/RubiconV2_Arbitrum_Goerli | + +## Python SDK + +A Python library for interacting with Rubicon. Contains a growing list of utility functions for retrieving and formatting data from the Rubicon API. The SDK is open source and available on [Github](https://github.com/RubiconDeFi/rubi-py). + +- [SDK Docs](https://rubi.readthedocs.io/en/latest/) +- [Python SDK Package](https://pypi.org/project/rubi/) +- [Python SDK Github Repo](https://github.com/RubiconDeFi/rubi-py) From f32272b86288a1491192820447ee631c361c7b07 Mon Sep 17 00:00:00 2001 From: denver Date: Tue, 18 Jul 2023 19:03:49 -0400 Subject: [PATCH 3/3] update: reworded --- pages/api-guides/api-overview.en.mdx | 5 ++--- pages/api-guides/api-overview.mdx | 5 ++--- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/pages/api-guides/api-overview.en.mdx b/pages/api-guides/api-overview.en.mdx index 0625605..84d6ee8 100644 --- a/pages/api-guides/api-overview.en.mdx +++ b/pages/api-guides/api-overview.en.mdx @@ -8,12 +8,11 @@ import { Callout } from "/components/Callout"; # Rubicon APIs -Rubicon has several APIs for retrieving data regarding the protocol. While you can always interact directly with the [Rubicon smart contracts](/protocol/deployments) to get data regarding current chain state, the APIs provide a convenient way to query both current and historical data from the protocol, solving the problems typically associated with blockchain data retrieval. The APIs are powered by [The Graph](https://thegraph.com/), and you can learn more about them in our [Subgraphs](/api-guides/subgraphs/subgraphs) section. +Rubicon provides various APIs for accessing protocol data. Rather than manually engaging with [Rubicon smart contracts](/protocol/deployments) for chain state info, these APIs allow for easy querying of current and past data, bypassing standard blockchain data retrieval hurdles. Powered by [The Graph](https://thegraph.com/), additional details on these APIs can be found in our [Subgraphs](/api-guides/subgraphs/subgraphs) section. ## Hosted API -Rubicon provides a hosted API for retrieving data regarding the protocol. This API is free of charge to all user's, and aims to provide the most up-to-date information regarding the protocol. In addition to Rubicon's hosted API, users can also access data through [The Graph's Hosted Service](https://thegraph.com/hosted-service), which serves as a backup to Rubicon's own hosted hardware. Soon, Rubicon will migrate its API to the [decentralized network](https://thegraph.com/explorer), where users can expect even greater reliability and performance. - +Rubicon offers a free hosted API for protocol data. This API, supplemented by [The Graph's Hosted Service](https://thegraph.com/hosted-service) as a backup, aims to deliver the latest protocol information. In the near future, Rubicon will transition its API to the [decentralized network](https://thegraph.com/explorer) for enhanced reliability and performance. ### Deployments diff --git a/pages/api-guides/api-overview.mdx b/pages/api-guides/api-overview.mdx index 0625605..d30dd5c 100644 --- a/pages/api-guides/api-overview.mdx +++ b/pages/api-guides/api-overview.mdx @@ -8,12 +8,11 @@ import { Callout } from "/components/Callout"; # Rubicon APIs -Rubicon has several APIs for retrieving data regarding the protocol. While you can always interact directly with the [Rubicon smart contracts](/protocol/deployments) to get data regarding current chain state, the APIs provide a convenient way to query both current and historical data from the protocol, solving the problems typically associated with blockchain data retrieval. The APIs are powered by [The Graph](https://thegraph.com/), and you can learn more about them in our [Subgraphs](/api-guides/subgraphs/subgraphs) section. +Rubicon provides various APIs for accessing protocol data. Rather than manually engaging with [Rubicon smart contracts](/protocol/deployments) for chain state info, these APIs allow for easy querying of current and past data, bypassing standard blockchain data retrieval hurdles. Powered by [The Graph](https://thegraph.com/), additional details on these APIs can be found in our [Subgraphs](/api-guides/subgraphs/subgraphs) section. ## Hosted API -Rubicon provides a hosted API for retrieving data regarding the protocol. This API is free of charge to all user's, and aims to provide the most up-to-date information regarding the protocol. In addition to Rubicon's hosted API, users can also access data through [The Graph's Hosted Service](https://thegraph.com/hosted-service), which serves as a backup to Rubicon's own hosted hardware. Soon, Rubicon will migrate its API to the [decentralized network](https://thegraph.com/explorer), where users can expect even greater reliability and performance. - +Rubicon offers a free hosted API for protocol data. This API, supplemented by The Graph's Hosted Service as a backup, aims to deliver the latest protocol information. In the near future, Rubicon will transition its API to the decentralized network for enhanced reliability and performance. ### Deployments