The Grid - Public Docs

The Grid - Public Docs

The Grid Developer 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.7 - Bets - 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

Parameter ID

Definition

Is enum

VTGS

Depricated

Modified on

Products

Name

products.name

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

11/22/2024, 10:31 PM

Type

products.productType

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

11/27/2024, 4:40 PM

Description

products.description

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

11/27/2024, 7:54 PM

Product Status

products.productStatus

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

11/27/2024, 3:29 PM

Is Main product?

products.isMainProduct

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

11/20/2024, 5:12 PM

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.

11/25/2024, 9:15 PM

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.

11/20/2024, 5:08 PM

Asset

Name

assets.name

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

11/20/2024, 5:07 PM

Ticker

assets.ticker

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

11/20/2024, 5:07 PM

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.

11/22/2024, 10:48 PM

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.

11/27/2024, 7:54 PM

Asset Type

assets.assetTypes

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

11/22/2024, 10:44 PM

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.

11/20/2024, 5:07 PM

Associated Profile

assets.profile

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

11/20/2024, 5:07 PM

Asset Status

assets.assetStatus

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

11/27/2024, 3:29 PM

Entity

Name

entities.name

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

11/20/2024, 5:08 PM

Trade Name

entities.tradeName

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

11/20/2024, 5:08 PM

Type

entities.entityTypes

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

11/20/2024, 5:08 PM

Date of incorporation

entities.dateOfIncorporation

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

11/20/2024, 5:08 PM

Parent Entity

entities.parentEntity

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

11/20/2024, 5:08 PM

Reg number

entities.localRegistrationNumber

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

11/20/2024, 5:07 PM

Tax identification number

entities.taxIdentificationNumber

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

11/20/2024, 5:07 PM

Address

entities.address

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

11/20/2024, 5:07 PM

Country

entities.country

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

11/20/2024, 5:07 PM

LEI Code

entities.leiNumber

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

11/20/2024, 5:07 PM

Socials

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.

11/27/2024, 4:48 PM

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.

11/20/2024, 5:06 PM

profileInfos

Name

profileInfos.name

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

11/20/2024, 5:20 PM

Type

profileInfos.profileType

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

11/27/2024, 4:40 PM

Sector

profileInfos.profileSector

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

11/27/2024, 4:48 PM

Current Status

profileInfos.profileStatus

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

11/27/2024, 3:29 PM

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.

11/25/2024, 9:22 PM

Logo

profileInfos.logo

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

11/22/2024, 10:48 PM

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.

11/27/2024, 8:02 PM

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.

11/27/2024, 7:54 PM

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. Only use a full stop in a tagline if the original source uses one.

11/20/2024, 5:12 PM

Slug

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

11/25/2024, 9:19 PM

Tags

Name

tags.name

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

11/20/2024, 4:50 PM

Tag Type

tags.tagTypes

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.

11/22/2024, 5:01 PM

Description

tags.description

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

11/20/2024, 5:06 PM

11/27/2024, 8:01 PM

smartContractDeployments

Deployment Type

smartContractDeployments.deploymentTypes

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

11/20/2024, 5:06 PM

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.

11/20/2024, 5:06 PM

Uses Standard

smartContractDeployments.assetStandards

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

11/22/2024, 10:33 AM

smartContracts

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.

11/20/2024, 5:06 PM

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.

11/20/2024, 5:06 PM

Address

smartContracts.address

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

11/20/2024, 5:06 PM

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.

11/20/2024, 5:06 PM

Urls

URL Type

urls.urlType

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

11/27/2024, 4:48 PM

URL

urls.url

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

11/20/2024, 5:06 PM

ProductAssetRelationship

Product

productAssetRelationship.product

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

11/21/2024, 9:41 PM

Asset

productAssetRelationship.asset

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

11/21/2024, 10:42 PM

Product Asset Relationship Type

assets.assetSupportTypes

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

11/21/2024, 9:42 PM

⁠

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.