The Grid - Public Docs

The Grid - Public Docs

Welcome to The Grid Docs

TGS - Data model

TGS Change Log

Lenses at The Grid

This is The Grid Standard (TGS). The data structure that can be requested from The Grids API.

The goal is that this Standard will change over time with the addition of more data-points, bringing more depth depending on user requirements.

Current version V0.6 - Alpha - To see the changelog, go to

TGS Change Log⁠

We are soon moving to 0.7, please see the changelog to preview upcoming changes.

Our goal is to never subtract, always extend.

This table is broken down by which data will be stored in core database ‘tables’, we also call tables ‘lenses’ in the Grid.

To learn about lens, go here

Lenses at The Grid⁠

Our goal is that parameter names will not change with updates, only new ones added.

Notes:

With ‘types’, like sectors / project type, you will be returned definitions as well.

TGS Data Dictionary

TGS Data Dictionary

Table

Name

Parameter ID

Description

Profile

Name

profiles.name

The full official name of the Profile as used in their branding and documentation.

Type

profiles.profileType

The primary operational category or business model of the Profile (e.g. DAO, project, investor, government). Refer to standardized list of Profile types.

Sector

profiles.profileSector

The primary industry, use case, or problem space the Profile operates in or serves. Refer to standardized list of sectors and subsectors.

Current Status

profiles.profileStatus

The current operational state of the Profile (e.g. Active, Inactive, Closed). Refer to the standardized list of status options.

Founding date

profiles.foundingDate

The date when the Profile was first established, registered, or publicly announced. Use ISO 8601 format (YYYY-MM-DD) when possible.

Logo

profiles.logo

A PNG or SVG image file representing the Profile's logo, with a transparent background and a minimum resolution of 256x256 pixels.

Short Description

profiles.descriptionShort

Provide an objective overview of the Profile's primary purpose, product, or service. Avoid subjective claims, marketing language, or unnecessary technical jargon. Focus on clear, factual information. Limit to 140 characters.

Long Description

profiles.descriptionLong

A more detailed overview of the Profile, including its mission, target audience, and key features or offerings. Limit to 500 characters and avoid subjective claims.

Tag line

profiles.tagLine

A brief, memorable phrase or slogan used by the Profile to convey its mission or value proposition. If no official tagline is found, leave this field blank.

Main URL

profiles.urlMain

The primary official website URL for the Profile.

Blog URL

profiles.urlBlog

The URL of the Profile's primary blog or news section. If not available, leave blank rather than inferring or creating a URL.

Documentation URL

profiles.urlDocumentation

The URL of the Profile's primary technical documentation or knowledge base. If not available, leave blank rather than inferring or creating a URL.

Whitepaper URL

profiles.urlWhitepaper

The URL of the Profile's most recent whitepaper or technical document outlining its technology, roadmap, and token economics.

Slug

profiles.slug

A URL-friendly version of the Profile's name, used for creating unique, readable URLs and internal references. The slug is automatically generated from the Profile's name, consisting of lowercase letters, numbers, and hyphens.

Products

Name

products.name

The official name of the product as used in its branding, marketing, and user-facing materials.

Type

products.productType

The primary category or function of the product (e.g. exchange, wallet, lending platform). Refer to standardized list of product types.

Description

products.descriptionShort

A concise, objective statement explaining what the product does and who it is for. Avoid subjective claims and can include technical jargon. This must be under 500 characters.

URL

products.urlToProduct

The primary URL where users can access or download the product. Use the root domain without "www" or "https://".

Product Status

products.productStatus

The current development or access stage of the product (e.g. Beta, Live, Deprecated). Refer to the standardized list of product status options.

Address

products.productAddress

The smart contract address(es) associated with the product, if applicable. Use a comma-separated list if multiple addresses are relevant.

Is Main product?

products.isMainProduct

A boolean value indicating whether the product is the Profile's primary or flagship offering.

Launch Date

products.launchDate

The date when the product was first launched or made publicly available. Use ISO 8601 format (YYYY-MM-DD) when possible.

DeployedOn

products.deployedOnProduct

The blockchain network(s) or platform(s) on which the product is deployed or built upon.

Main Asset

products.mainAsset

The main asset that the product supports or is required for functioning of the product. For example, In the case of an L1 like Ethereum, this would be ETH.

Profile

products.profile

A reference to the Profile associated with the product, using the Profile's unique identifier or name.

productSupports

products.productSupports

Lists all the products that this product supports. Not used for onchain deployed but for network or developer tooling support for example.

Asset

Name

assets.name

The official name of the Asset as used in its branding, marketing, and trading materials.

Ticker

assets.ticker

The unique trading symbol used to represent the Asset on exchanges and trading platforms. Use only capital letters and numbers.

Icon

assets.icon

A square PNG but ideally an SVG image file representing the Asset's icon or logo, with a transparent background and a minimum resolution of 128x128 pixels.

Short Description

assets.shortDescription

A concise, one-sentence summary of the Asset's key characteristics, use case, or value proposition. Limit to 200 characters and avoid subjective claims.

Asset Type

assets.assetType

The primary category or function of the Asset (e.g. Currency, Utility, Security). Refer to the standardized list of asset types.

URL to asset docs

assets.urlToAssetDocs

The URL of the Asset's official documentation, whitepaper, or technical specification. Use the root domain without "www" or "https://".

Address

assets.address

The unique smart contract address of the Asset on the blockchain it is deployed on. Use a standard blockchain explorer to validate the address.

Asset Standard

assets.assetStandard

The technical standard or protocol the Asset adheres to, based on the blockchain it is deployed on (e.g. ERC-20, BEP-20).

Deployed on

assets.deployedOnProduct

The blockchain network(s) on which the Asset is deployed or issued. Use a comma-separated list if the Asset is deployed on multiple networks.

Associated Profile

assets.profile

A reference to the Profile associated with the Asset, using the Profile's unique identifier or name.

Entity

Name

entities.name

The legal name of the Entity as registered with the relevant regulatory bodies or government agencies.

Trade Name

entities.tradeName

Any additional trading names, brands, or trademarks associated with the Entity, separate from its legal name.

Type

entities.entityType

The legal structure or registration category of the Entity (e.g. LLC, Foundation, Corporation). Refer to the standardized list of entity types.

Date of incorporation

entities.dateOfIncorporation

The date when the Entity was legally registered or incorporated. Use ISO 8601 format (YYYY-MM-DD) when possible.

url

entities.urlToEntity

The primary official website URL for the Entity, not the profile. The holding company may have a separate URL.

Associated Profile

entities.profile

A reference to the Profile associated with the Entity, using the Profile's unique identifier or name.

Parent Entity

entities.parentEntity

A reference to the parent Entity, if applicable, using the parent Entity's unique identifier or name.

Reg number

entities.localRegistrationNumber

The registration number assigned to the Entity by the relevant regulatory body or government agency, if applicable.

Tax identification number

entities.taxIdentificationNumber

The unique tax identification number assigned to the Entity by the relevant tax authority, if applicable.

Address

entities.address

The registered physical address of the Entity, including street, city, state/province (if applicable), and postal code.

Country

entities.country

The country in which the Entity is legally registered or incorporated, using the ISO 3166-1 alpha-2 country code format.

LEI Code

entities.leiNumber

The Legal Entity Identifier (LEI) code assigned to the Entity by the Global Legal Entity Identifier Foundation (GLEIF), if applicable.

Socials

url

socials.url

The URL of the Profile's official social media account or page on the specified platform. Use the full URL, including "https://" and any relevant subdomains or paths.

Type of socials

socials.socialType

The specific social media platform the URL belongs to (e.g. Twitter, Facebook, Discord). Refer to the standardized list of social media platforms.

Name

socials.name

The name or handle associated with the Profile's social media account on the specified platform. This should match the name displayed on the social media profile page.

⁠

Want to print your doc?
This is not the way.

Try clicking the ⋯ next to your doc name or using a keyboard shortcut (

CtrlP

) instead.