Skip to content

Commit

Permalink
Merge pull request #311 from ArtBlocks/add-base-endpoints
Browse files Browse the repository at this point in the history
Add Base Endpoints to API Overview
  • Loading branch information
lindsgil authored Jun 26, 2024
2 parents 1dcfae3 + cc725d3 commit 772fa04
Showing 1 changed file with 25 additions and 16 deletions.
41 changes: 25 additions & 16 deletions art-blocks-api/api-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,14 @@ Provides the token metadata for a given Art Blocks token.
| ------------- | ------------------------------------------------------------------------- |
| Engine | `https://token.arbitrum-sepolia.artblocks.io/{contractAddress}/{tokenID}` |

**Base Mainnet**

- Note: Contract address is required

| Contract Type | Pattern |
| ------------- | ----------------------------------------------------------------- |
| Engine | `https://token.base.artblocks.io/{contractAddress}/{tokenID}` |

<br>

### Generator API
Expand Down Expand Up @@ -90,6 +98,14 @@ Provides an i-frame-able live-view for the art associated with a given Art Block
| ------------- | ----------------------------------------------------------------------------- |
| Engine | `https://generator.arbitrum-sepolia.artblocks.io/{contractAddress}/{tokenID}` |

**Base Mainnet**

- Note: Contract address is required

| Contract Type | Pattern |
| ------------- | --------------------------------------------------------------------- |
| Engine | `https://generator.base.artblocks.io/{contractAddress}/{tokenID}` |

<br>

### Media API/Media server
Expand Down Expand Up @@ -126,6 +142,14 @@ Provides a static snapshot of the rendered live-view for a given Art Blocks toke
| ------------- | ------------------------------------------------------------------------------- |
| Engine | `https://media-proxy-arbitrum-staging.artblocks.io/{contractAddress}/{tokenID}` |

**Base Mainnet**

- Note: Contract address is required

| Contract Type | Pattern |
| ------------- | ----------------------------------------------------------------------- |
| Engine | `https://media-proxy-base.artblocks.io/{contractAddress}/{tokenID}` |

---

In addition to the standard static renders provided for each token, there are two other static renders currently provided: "HD" and "thumbnail". These items can be found at:
Expand All @@ -137,22 +161,6 @@ Please note that these additional static render formats are still currently bein

Please also note that the Generator API and Media API links for a given token are included in the token response for that token from the Token API.

**Mainnet (Engine)**

We are working on a media server for Engine partners. Currently, media is accessible through individual s3 buckets.

| Render Type | Pattern | Sample |
| ----------- | ---------------------------------------------------------------------- | ----------------------------------------------------------------- |
| Standard | `https://{enginePartner}-mainnet.s3.amazonaws.com/{tokenID}.png` | https://bright-moments-mainnet.s3.amazonaws.com/8000000.png |
| Thumbnail | `https://{enginePartner}-mainnet.s3.amazonaws.com/thumb/{tokenID}.png` | https://bright-moments-mainnet.s3.amazonaws.com/thumb/8000000.png |

**Testnet**

| Contract Type | Render Type | Pattern | Sample |
| ------------- | ----------- | ------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------- |
| Flagship | Standard | `https://art-blocks-artist-staging-sepolia.s3.us-west-1.amazonaws.com/{tokenID}.png` | https://art-blocks-artist-staging-goerli.s3.us-west-1.amazonaws.com/10000000.png |
| Engine | Standard | `https://{enginePartner}-sepolia.s3.amazonaws.com/{tokenID}.png` | https://bright-moments-goerli.s3.amazonaws.com/1000000.png |

## Art Blocks Subgraph

Art Blocks has subgraphs deployed to [The Graph Network](https://thegraph.com/docs/en/network/overview/) for every supported network.
Expand Down Expand Up @@ -269,6 +277,7 @@ Provides a broader set of the data that our front-end consumes — this includes
| Ethereum | Staging (deprecated) | `https://ab-staging-goerli.hasura.app/v1/graphql` |
| Arbitrum | Production | `https://ab-prod-arbitrum.hasura.app/v1/graphql` |
| Arbitrum | Staging | `https://ab-staging-arbitrum.hasura.app/v1/graphql` |
| Base | Mainnet | `https://ab-prod-base.hasura.app/v1/graphql` |

#### Authentication

Expand Down

0 comments on commit 772fa04

Please sign in to comment.