Skip to main content

GraqhQL APIs

When you are building social apps, you need to fetch data quickly to provide a smooth experience for your users.

Subsocial provides you with the Subsocial GraphQL endpoint, which can be used to query the blockchain instantaneously.

Getting Started​

You can add GraphQL and the Apollo client to a new or existing project.

To add create a new project, you can use the Subsocial Starter.

Install the following dependencies:

yarn add @apollo/client graphql

Setup​

Our GraphQL API endpoint: https://squid.subsquid.io/soonsocial/graphql

import { ApolloClient, InMemoryCache, gql } from '@apollo/client'

const API_URL = 'https://squid.subsquid.io/soonsocial/graphql'

/* create the API client */
export const client = new ApolloClient({
  uri: API_URL,
  cache: new InMemoryCache()
})

Read more about Subsocial testnet here.

note

Detailed docs on GraphQL API & query options can be found easily on the API Endpoint here.

Creating Queries​


/* define a GraphQL query  */
export const explorePosts = gql`
query MyQuery {
  posts(orderBy: reactionsCount_DESC, limit: 3, where: {createdAtTime_gt: "2023-01-01T00:00:00.000000Z"}) {
    content
    title
    reactionsCount
    sharedPost {
      id
    }
    createdAtTime
    space {
      id
      name
      summary
    }
  }
}
`

The above query fetches the top 3 most liked posts of this year. You can choose the data you need from the query, and leverage the power of GraphQL.

Use the GraphQL Playground to explore the queries.

Running Queries​

const response = await client.query({ query: explorePosts })

Response:

{
  "data": {
    "posts": [
      {
        "content": "bafyreigvgydzk42f2uynxlvrqdfmylhysopqgcctt6gxiwfc6jbmc5z73i",
        "title": "Trustless Bitcoin on Polkadot... So What's Next? - Space Monkeys 081",
        "reactionsCount": 2,
        "sharedPost": null,
        "createdAtTime": "2023-01-01T16:55:24.340000Z",
        "space": {
          "id": "4809",
          "name": "The Kusamarian",
          "summary": "Threads and Videos from the Jay Chrawnna vault"
        }
      },
      {
        "content": "bafyreieoory7axld6mw2i6gpwfxy3scesy4l65vawc7lcnwgbdsl6thbfy",
        "title": null,
        "reactionsCount": 1,
        "sharedPost": null,
        "createdAtTime": "2023-01-01T16:33:54.261000Z",
        "space": {
          "id": "10714",
          "name": "polbatona",
          "summary": "Web 3.0"
        }
      },
      {
        "content": "bafyreiacd3ae2maa3tbwu2eomsvysrfopowo6xmp4g2sprslfaapieayba",
        "title": "December 2022 In Review",
        "reactionsCount": 1,
        "sharedPost": null,
        "createdAtTime": "2023-01-03T15:13:36.362000Z",
        "space": {
          "id": "1",
          "name": "Subsocial",
          "summary": "Subsocial is a web3 social networking platform built to support the social apps of the future. These apps will feature built-in monetization methods and censorship resistance, where users own their content and social graphs.\n\nSubsocial is a one-of-a-kind in the Polkadot ecosystem, and designed..."
        }
      }
    ]
  }
}

More Examples​

News Feed​

Get a list of posts for an address's news feed.

This excludes:

  • Posts made by themselves
  • Posts that are technically comments
/* define a GraphQL query  */
export const getNewsFeed = gql`
  query GetNewsFeeds($address: String!, $offset: Int = 0, $limit: Int!) {
      accountById(id: $address) {
        feeds(
          limit: $limit
          offset: $offset
          orderBy: activity_date_DESC
          where: { activity: { account: { id_not_eq: $address }, post: { isComment_eq: false } } }
        ) {
          activity {
            post {
              id
              isComment
              title
            }
          }
        }
      }
    }
`

Get Notifications​

Get notifications data for a specific address.

You can set the aggregated property true to club the notifications together that are about the same post, for example: 

  A like post Z
  B like post Z

  You can club them togather like this:
  {
    aggregated: true
    aggCount: 2
    ...
  }

The amount of same notifcations that are aggregated is in aggCount.

/* define a GraphQL query  */
export const getNotifications = gql`
  query GetNotifications($address: String!, $offset: Int = 0, $limit: Int!) {
      accountById(id: $address) {
        notifications(
          where: { activity: { aggregated_eq: true, account: { id_not_eq: $address } } }
          limit: $limit
          offset: $offset
          orderBy: activity_date_DESC
        ) {
          id
          activity {  
            aggCount
            aggregated
            post {
              id
              isComment
            }
            space {
              id
            }
            followingAccount {
              id
            }
            reaction {
              id
            }
          }
        }
      }
    }
`