AwesomeNEAR aims to help the NEAR community navigate and contextualize this fast growing ecosystem with more ease and clarity. We are now introducing the AwesomeNEAR APIs.

AwesomeNEAR APIs provide access to a wealth of information about the NEAR ecosystem, including project profiles, NEAR rankings. With our APIs, developers can easily integrate this information into their own applications and platforms, making it easier than ever to stay up-to-date on the latest developments in the NEAR ecosystem. Whether you're a developer, investor, or simply curious about NEAR, our APIs are a valuable resource for anyone looking to explore this exciting NEAR ecosystem.

Get started

To get started with AwesomeNEAR APIs, simply contact us for an API key. Once you have your key, you can start making requests to our API endpoints via GraphQL and retrieve the information you need.

GraphQL Endpoint

The GraphQL API has one single endpoint:

<https://awesomenear.com/api/graphql/public>

Authenticating with GraphQL

To authenticate with GraphQL, include your API key in an HTTP header like this:

Authorization: Bearer YOUR_API_KEY

Schema Introspection

You can explore the API and GraphQL schema at https://awesomenear.com/api/graphql/public.

You may use our APIs to retrieve project results by using queries such as trending, categories (by category), projects(by token contract address or token symbol), validators (by NEAR node address), or octopus(by Octopus Appchain ID).

Results retrieved from GraphQL API follow GraphQL Cursor Connections Specification.

query AwesomeQuery {
  trending {
    edges {
      node {
        [PublicProject]
      }
    }
  }
  categories(filter: {categories: [category]}) {
    edges {
      node {
        [PublicProject]
      }
    }
  }
  projects(
    filter: {contractAddress: {address: $token_contract_address, chain: $token_contract_chain}}
  ) {
    edges {
      node {
        [PublicProject]
      }
    }
  }
	projects(
    filter: {symbol: $token_symbol}
  ) {
    edges {
      node {
        [PublicProject]
      }
    }
  }
  validators(filter: {address: $validator_address}) {
    edges {
      node {
        [PublicProject]
      }
    }
  }
  octopus(filter: {appchainId: $octopus_appchain_id}) {
    edges {
      node {
        [PublicProject]
      }
    }
  }
}

By using the PublicProject type in your queries, you can retrieve detailed information about projects on the NEAR ecosystem.

node {
  title                                # Project's title
  appchainId                           # Octopus Appchain ID
  astroDAO                             # AstroDAO contract ID
  categories                           # Project's categories
  chains                               # NEAR / Aurora / Octopus
  contractsAddresses {                 # Project's token contracts
    aurora
    ethereum
    near
    octopus
  }
  dapp                                 # DApp link
  description                          # Project's description
  discord                              # Project's Discord URL
  facebook                             # Project's Facebook URL
  github                               # Project's GitHub URL
  grants                               # Project's grants
  investors                            # Project's investors
  link                                 # AwesomeNEAR permalink 
  linkedIn                             # Project's LinkedIn URL
  logo                                 # Project's logo URL
  medium                               # Project's Medium URL
  nodeAddress                          # NEAR validator address
  oneliner                             # Project oneliner description
  status                               # Active / Building / Inactive
  symbols                              # Project's token symbols
  telegram                             # Project's Telegram URL
  twitter                              # Project's Twitter URL
  website                              # Project's official website URL
  whitepaper                           # Project's whitepaper or doc URL
}

Credit

It would be awesome to include AwesomeNEAR logo or/and credit in your DApps. Furthermore, you can utilize the link (project permalinks) mentioned above in your project to connect with AwesomeNEAR for more comprehensive information..