The Grid - Public Docs

Pages

The Grid Developer Docs

TGS - Data model

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.7 - Beta - To see the changelog, go to

TGS Change Log⁠

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

TGS lenses

Parameter ID

Definition

Is enum

VTGS

Data license

Name

profileInfos.name

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

Type

profileInfos.profileTypeId

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

Sector

profileInfos.profileSectorId

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

Current Status

profileInfos.profileStatusId

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

Founding date

profileInfos.foundingDate

The date when the Profile was first established, registered, or publicly announced. Use ISO 8601 format (YYYY-MM-DD) when possible. Can usually be shortened to Month and Year.

Logo

profileInfos.logo

Provide your full logo (wordmark + icon) that works on a white background and be transparent. Preferably an SVG image file. If it is a PNG, it should have a minimum resolution of 256px height.

Short Description

profileInfos.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 200 characters.

Long Description

profileInfos.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.

Tagline

profileInfos.tagLine

A brief, memorable phrase or slogan used by the Profile to convey its mission or value proposition. If the tagline is in all caps or contains irregular spaces or line breaks, reformat it to a single line, single spaced, and sentence case.

Root ID

profileInfos.rootId

A link to the root

profileInfos.id

Unique Identifier - Of the profile.

Icon

profileInfos.icon

Provide a profile icon that works on a white background and be transparent. Preferably an SVG image file. If it is a PNG, it should have a minimum resolution of 256px height.

Icon

profileInfos.logo

Provide your full icon. Ensure that it is an SVG and looks great. This will be shown in alot of places.

Name

products.name

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

Type

products.productTypeId

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

Description

products.description

A concise, objective statement explaining what the product does and who it is for.

Product Status

products.productStatusId

The current development or access stage of the product (e.g. Beta, Live, Deprecated).

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.

productSupports

products.supportsProducts

Lists all the products that this product explicitly supports. This also describes a direction of support, for example a wallet may support a chain, but a chain does not support a wallet. Not used for on-chain deployments.

RootID

products.rootId

products.id

Unique Identifier - Of the product.

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.assetTypeId

The primary category or function of the Asset (e.g. Currency, Utility, Security) and what is does.

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.

Associated root

assets.rootId

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

Asset Status

assets.assetStatusId

The current development or access stage of the asset. Refer to the standardized list of asset status options.

Asset ID

assets.id

Unique Identifier

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.entityTypeId

The legal structure or registration category of the Entity (e.g. LLC, Foundation, Corporation).

Date of incorporation

entities.dateOfIncorporation

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

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.

entities.id

Unique Identifier - Of the entity.

RootID

entities.rootId

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.

socials.id

Unique Identifier

Table ID

socials.tableId

Row ID

socials.rowId

A pointer that points to a row in one of a few core table names.

Slug

roots.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.

Root ID

roots.id

Unique Identifier

URL Root

urlRoot

Name

tags.name

The name of a tag which is a reference to something. This something is defined by its description and type.

Tag Type

tags.tagTypeId

A reference to a connected table that contains a type. A type of tag provides some context as to what a tag is and also contains a description.

Description

tags.description

A description of this tag which provides a short explanation over what this unique tag is about

tags.id

Unique Identifier

Deployment Type

smartContractDeployments.deploymentTypeId

Categorizes the type of deployment based on the smart contract’s main purpose. For example, if the contract is primarily used to mint an asset, it will be tagged as ‘mint’.

Deployed On

smartContractDeployments.deployedOnId

Specifies which blockchain a smart contract is deployed on. If a product or asset does not have a smart contract, meaning it is not deployed on any blockchain, leave this field blank.

Uses Standard

smartContractDeployments.isOfStandardId

The technical standard or protocol specification that the smart contract implements. If the standard cannot be identified, leave this field blank.

smartContractDeployments.id

Unique Identifier

Deployment

smartContracts.deploymentId

The Deployment ID links individual smart contracts to their parent deployment record. A deployment can contain multiple related smart contracts (like a protocol's core contracts), but each blockchain deployment must have its own unique deployment record.

Name

smartContracts.name

The official identifier or label for the smart contract as used in project documentation and blockchain explorers. If no name is given, leave it blank.

Address

smartContracts.address

The unique blockchain address where the smart contract is deployed. Format must match the relevant blockchain's address structure.

Deployment Date

smartContracts.deploymentDate

The date when the smart contract was deployed to the blockchain. Use ISO 8601 format (YYYY-MM-DD). Note: This will be automated in the future.

smartContracts.id

Unique Identifier

URL Type

urls.urlTypeId

Categorizes the purpose and content of a URL based on its table group in the TGS. The URL type must align with both the content it links to and the context of its parameter group (Profile/Product/Asset/Entity/Social).

URL

urls.url

This is a URL that links to different types, it must always start with a "http://" or "https://".

urls.id

Unique Identifier

Core Table

urls.tableId

Row

urls.rowId

Product

productAssetRelationships.productId

A product entry that maintains a defined relationship with one or more assets through integration, display, or functional requirements.

Asset

productAssetRelationships.assetId

An asset entry that functions within a specific product through integration, serving purposes defined by its Asset Type parameter.

Product Asset Relationship Type

productAssetRelationships.typeOfSupportId

A classification of the functional relationship between a product and an asset, indicating how the asset is utilized within the product's operations.

productAssetRelationships.id

Unique Identifier

assetStandards.id

Auto-incrementing primary key for the asset standard

Standard Name

assetStandards.name

The name of the technical standard (e.g. ERC20 or SPL)

Standard Description

assetStandards.definition

Detailed description of the standard's purpose and characteristics

Unique Identifier

assetStatuses.id

Auto-incrementing primary key for the asset status

Status Name

assetStatuses.name

The name of the status (e.g. Active or Deprecated)

Status Description

assetStatuses.definition

Description of what this status means for an asset

Unique Identifier

assetSupportTypes.id

Auto-incrementing primary key for the support type

Support Type Name

assetSupportTypes.name

Name of the support relationship type

Support Type Description

assetSupportTypes.definition

Description of how this type of support functions between assets

Unique Identifier

productTypes.id

Auto-incrementing primary key for the product type

Product Type Name

productTypes.name

Name of the product category

Product Type Description

productTypes.definition

Description of what this product type encompasses

Unique Identifier

assetTypes.id

Auto-incrementing primary key for the asset type

Asset Type Name

assetTypes.name

Name of the asset category

Asset Type Description

assetTypes.definition

Description of what this type of asset represents

Unique Identifier

entityTypes.id

Auto-incrementing primary key for the entity type

Entity Type Name

entityTypes.name

Name of the entity structure type

Entity Type Description

entityTypes.definition

Description of what this type of entity structure represents

Unique Identifier

productStatuses.id

Auto-incrementing primary key for the product status

Status Name

productStatuses.name

Name of the product status

Status Description

productStatuses.definition

Description of what this status means for a product

Unique Identifier

profileSectors.id

Auto-incrementing primary key for the profile sector

Sector Name

profileSectors.name

Name of the business/operation sector

Sector Description

profileSectors.definition

Description of what this sector encompasses

Unique Identifier

profileStatuses.id

Auto-incrementing primary key for the profile status

Status Name

profileStatuses.name

Name of the profile status

Status Description

profileStatuses.definition

Description of what this status means for a profile

Unique Identifier

profileTypes.id

Auto-incrementing primary key for the profile type

Type Name

profileTypes.name

Name of the profile type

Type Description

profileTypes.definition

Description of what this type of profile represents

Unique Identifier

socialTypes.id

Auto-incrementing primary key for the social media type

Platform Name

socialTypes.name

Name of the social media platform

Platform Description

socialTypes.definition

Description of the social media platform type

Unique Identifier

deploymentTypes.id

Auto-incrementing primary key for the deployment type

Deployment Type Name

deploymentTypes.name

Name of the deployment type

Deployment Description

deploymentTypes.definition

Description of what this deployment type represents

Unique Identifier

tagTypes.id

Auto-incrementing primary key for the tag type

Tag Type Name

tagTypes.name

Name of the tag category

Tag Type Description

tagTypes.definition

Description of what this type of tag represents

Unique Identifier

urlTypes.id

Auto-incrementing primary key for the URL type

URL Type Name

urlTypes.name

Name of the URL category

URL Type Description

urlTypes.definition

Description of what this type of URL represents

Unique Identifier

countries.id

Auto-incrementing primary key for the country

Country Name

countries.name

Official name of the country

Product

supportsProducts.productId

Supports Product

supportsProducts.supportsProductId

supportsProducts.id

Unique Identifier

derivative Asset

derivativeAssets.derivativeAssetId

Base Asset

derivativeAssets.baseAssetId

derivativeAssets.id

Unique Identifier

Product

productDeployments.productId

Product Deployment Info

productDeployments.deploymentId

productDeployments.id

Unique Identifier

Asset Deployment Info

assetDeployments.deploymentId

Asset

assetDeployments.assetId

assetDeployments.id

Unique Identifier

⁠

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.