jasper-edits

docs/Interpretation/_category_.json

@@ -2,5 +2,5 @@
   "label": "Interpretation",
   "position": 2,
   "collapsible": true,
-  "collapsed": false
+  "collapsed": true
 }

docs/api-intro/_category_.json

@@ -0,0 +1,6 @@
+{
+  "label": "API",
+  "position": 4,
+  "collapsible": true,
+  "collapsed": true
+}

docs/api-intro/api-intro.md

@@ -0,0 +1,47 @@
+---
+sidebar_position: 1
+---
+import ApolloSandboxComponent from '@site/src/components/ApolloSandboxComponent';
+
+
+# Getting Started
+
+
+Access powerful onchain data curated by the Zapper protocol with a GraphQL API for your applications.
+
+---
+
+## What do I get?
+
+#### [Human-Readable Transactions](/docs/api-intro/human-readable-transactions)
+
+Simplify onchain transactions with human-friendly descriptions.
+
+#### [Onchain Identity](/docs/api-intro/onchain-identity)
+
+Enrich your app by surfacing onchain identity such as avatars, ENS, Farcaster, and more.
+
+
+#### [Portfolio Balances](/docs/api-intro/token-balances)
+
+A set of portfolio queries to fetch tokens, NFTs, DeFi Positions, and other App Balances.
+
+
+#### [Onchain Prices](/docs/api-intro/app-balances)
+
+A price for every token that has an onchain market, including historical data. 
+
+## Get an API key
+
+Visit the **[Dashboard](/dashboard)** to get your API key.
+
+## Buy credits
+
+Zapper API uses a credit system to manage how many queries an API key can perform. Each query made costs a certain amount of credits, and these credits are deducted from your credit balance.
+
+You can track your usage and purchase additional credits on the API **[Dashboard](/dashboard)**
+
+
+## Try it in Sandbox
+
+<ApolloSandboxComponent />

docs/api-intro/app-balances.md

@@ -0,0 +1,119 @@
+---
+sidebar_position: 4
+sidebar_label: App Balances
+---
+
+import ApolloSandboxComponent from '@site/src/components/ApolloSandboxComponent';
+
+export const appBalancesQuery = `query Portfolio($addresses: [Address!]!) {
+  portfolio(addresses: $addresses) {
+    appBalances {
+      address
+      appName
+      balanceUSD
+      network
+      products {
+        label
+        assets {
+          address
+        }
+      }
+    }
+  }
+}`;
+
+export const appBalancesVars = {
+  "addresses": ["0xd8da6bf26964af9d7eed9e03e53415d37aa96045"]
+};
+
+# App Balances
+
+Surfaces balances that a user might hold inside of an onchain application. Use cases include showing DeFi positions, claimables, or portfolio tracking.
+
+---
+
+
+
+### `appBalances`
+
+The `appBalances` query takes an `address` with optional `networks` or `appIds` and returns fields such as `appId`, `appName`, `balanceUSD`, `assets`, `label` and other data useful for app balance use cases.
+
+
+### Common Uses
+
+##### App Holdings
+
+Imagine you want to surface all positions a user has across in every onchain app they have used for a particular network. You would pass `address` for the user and `network` for the selected chain returning the `appBalances` object, with fields such as `address`, `appName`, `balanceUSD`, `network`, and `products`. Example of the response below:
+
+
+```json
+  {
+    "address": "0xe321bd63cde8ea046b382f82964575f2a5586474",
+    "appName": "Aave V3",
+    "balanceUSD": 46.05200420761579,
+    "network": "OPTIMISM_MAINNET",
+    "products": [
+      {
+        "label": "Lending",
+           "assets": [
+              {
+                "address": "0x513c7e3a9c69ca3e22550ef58ac1c0088e918fff"
+              },
+              {
+                "address": "0x625e7708f30ca75bfd92586e17077590c60eb4cd"
+              },
+              {
+               "address": "0xe50fa9b3c56ffb159cb0fca61f5c9d750e8128c8"
+                }
+        }
+}
+```
+
+
+### Sandbox
+
+<ApolloSandboxComponent 
+  query={appBalancesQuery}
+  variables={appBalancesVars}
+/>
+
+
+:::note
+
+Smart accounts accounts like Maker’s `DSProxy` are automatically included in the balance response as part of an “implicit” bundle.
+
+Typically, a single transaction generates multiple timeline events: one for each wallet impacted by the transaction and one for the associated application, if any.
+
+:::
+
+### Reference
+
+<details>
+<summary>Arguments for appBalances</summary>
+
+| Argument      | Description | Type |
+| ----------- | ----------- | ----------- |
+| `address`      | Addresses for which to retrieve balances, inputted as an array.     | `String!` | 
+| `networks`      | Networks for which to retrieve balances, inputted an array.       | `Network!` | 
+| `appIds`      | Filter by a specific app.       | `String!` | 
+| `withOverrides`      | -       | `Boolean = false` | 
+
+</details>
+
+<details>
+<summary>Fields for appBalances</summary>
+
+
+| Field      | Description | Type |
+| ----------- | ----------- | ----------- |
+| `key`      | Description goes here.       | `String!`       |
+| `address`      | Address the position queried is for       | `String!`       |
+| `appId`      | ID of the app      | `String!`       |
+| `appName`      | Display name of app       | `String!`       |
+| `appImage`      | Icon of the app      | `String!`       |
+| `network`      | Network(s) the app is on.       | `Network!`       |
+| `updatedAt`      | Timestamp at which time this wallet's balance for this app was calculated   | `Timestamp!`       |
+| `balanceUSD`      | Value of all positions associated with this app on this network for this wallet, in USD      | `Float!` | 
+| `products`      | Object containing details on all products owned by this wallet       | `ProductItem!`       |
+
+</details>

docs/api-intro/human-readable-transactions.md

@@ -0,0 +1,135 @@
+---
+sidebar_position: 1
+sidebar_label: Human-Readable Transactions
+---
+import ApolloSandboxComponent from '@site/src/components/ApolloSandboxComponent';
+
+export const accountsTimelineQuery = `query($addresses: [Address!]) {
+  accountsTimeline(addresses: $addresses) {
+    edges {
+      node {
+        transaction {
+          fromUser {
+            address
+            displayName {
+              value
+            }
+          }
+          toUser {
+            displayName {
+              value
+            }
+          }
+        }
+        interpretation {
+          processedDescription
+        }
+      }
+    }
+  }
+}`;
+
+export const accountsTimelineVariables = {
+  "addresses": [
+    "0xd8da6bf26964af9d7eed9e03e53415d37aa96045",
+    "0x6f6e75fb472ee39d847d825cc7c9a613e227e261"
+  ]
+};
+
+# Human-Readable Transactions
+
+
+Presents onchain activity in a simple descriptive summary including references to dynamic elements of the transaction such as tokens, NFTs, and accounts. Great for use in account histories, social feeds, or app specific feeds.
+
+---
+
+### `accountsTimeline`
+
+The `accountsTimeline` query returns a descriptive and human-readable summary of the transaction's details from one or multiple wallets, along with tokens transferred, paginated, chain-agnostic. Typically, a single transaction generates multiple timeline events: one for each wallet impacted by the transaction and one for the associated application, if any.
+
+### Common Uses
+
+##### Transaction History
+
+Let's say you want to show users an activity feed for their onchain transactions in a human-readable format with network and app information. You would pass `addresses` for the user and return `processedDescription`, `network`, and `app`. Part of the response below:
+
+```json
+{
+  "fromUser": {
+    "address": "0x52c8ff44260056f896e20d8a43610dd88f05701b",
+      "displayName": {
+          "value": "0xjasper.eth"
+          }
+    }
+
+    "interpretation": {
+      "processedDescription": "Started battle with sebaudet.eth"
+      },
+
+      "network": "BASE_MAINNET"
+
+    "app": {
+      "name": "Tokiemon",
+      },
+}
+```
+
+:::note
+Textual description of each transaction is presented from the perspective of the signer. Events with descriptions such as "Did something with …" indicate that an interpreter for that type of onchain interaction is not available, yet.
+:::
+
+### Sandbox
+
+<ApolloSandboxComponent 
+  query={accountsTimelineQuery}
+  variables={accountsTimelineVariables}
+/>
+
+### Reference
+
+<details>
+<summary>Arguments for accountsTimeline</summary>
+
+| Argument      | Description | Type |
+| ----------- | ----------- | ----------- |
+| `network`      | Networks for which to retrieve, inputted as an array.    | `Network!`        | 
+| `realtimeInterpretation`      | Human-readable transactions, default is on       | `Boolean = true`        | 
+| `addresses`      | Addresses to retrive, inputted as an array.   | `String!`        | 
+| `tokenAddresses`      | Filter by token address        | `Address!`        | 
+| `isSigner`      | Filter by signer        | `Boolean`        | 
+| `spamFilter`      | Filter for spam, default is on      | `Boolean = true`        | 
+| `first`      | -      | `Int!`        | 
+| `after`      | -      | `String!`        | 
+
+
+
+</details>
+
+<details>
+<summary>Fields for accountsTimeline</summary>
+
+
+| Field      | Description | Type |
+| ----------- | ----------- | ----------- |
+| `key`      | A unique identifier.       | `String!`       |
+| `network`      | Network on which the transaction happened.     | `Network!`       |
+| `processedDescription`      | The human-readble description of the transaction.      | `ActivityInterpretation!`       |
+| `transaction`      | Contains onchain information like `nounce` , `hash`, `blockNumber`, `gasPrice` and more.       | `OnChainTransaction!`       |
+| `app`      | The app that is associate with the transaction.     | `Int!`       |
+| `fromUser`      | The address that the transaction was initiated from.     | `Int!`       |
+| `toUser`      | The address that the transaction interacted with.     | `Int!`       |
+| `displayName`      | Returns the display name of an address (ENS, Farcaster, Lens, etc.).   | `Int!`       |
+| `source`      | -       | `String!`       |
+| `eventType`      | Returns the event type.       | `String!`       |
+| `isAbiAvailable`      | -       | `Boolean!`       |
+| `isEditable`      | -       | `Boolean!`       |
+| `interpreterId`      | -      | `String!`       |
+| `interpreter`      | -      | `ActivityEventInterpreter!`       |
+| `actors`      | -       | `ActorDisplayItem!`       |
+| `timestamp`      | -       | `Timestamp!`       |
+| `perspective`      | -       | `ActivityPerspective!`       |
+| `similarEventCount`      | -       | `String!`       |
+| `perspectiveDelta`      | -       | `ActivityAccountDelta!`       |
+| `sigHash`      | -       | `String!`       |
+
+</details>