The Grid - Public Docs
The Grid Developer Docs
TGS - Data model
TGS Data Dictionary
Table
Name
Parameter ID
Definition
Is enum
VTGS
TGS lesnses
Data license
profileInfos
11
Name
The full official name of the Profile as used in their branding and documentation.
5
Profiles
Dual Licensed (ODbL & TGS license)
Special TPIP
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.
5
Profiles
Dual Licensed (ODbL & TGS license)
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.
5
Profiles
Dual Licensed (ODbL & TGS license)
Current Status
profileInfos.profileStatusId
The current operational state of the Profile (e.g. Active, Inactive, Closed). Refer to the standardized list of status options.
5
Profiles
Dual Licensed (ODbL & TGS license)
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.
5
Profiles
Dual Licensed (ODbL & TGS license)
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.
5
Profiles
Special TPIP
Dual Licensed (ODbL & TGS license)
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.
5
Profiles
Dual Licensed (ODbL & TGS license)
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.
5
Profiles
Dual Licensed (ODbL & TGS license)
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.
5
Profiles
Dual Licensed (ODbL & TGS license)
Special TPIP
Root ID
profileInfos.rootId
A link to the root
Profiles
products
9
Name
products.name
The official name of the product as used in its branding, marketing, and user-facing materials.
5
Products
Dual Licensed (ODbL & TGS license)
Special TPIP
Type
products.productTypeId
The primary category or function of the product (e.g. exchange, wallet, lending platform). Refer to standardized list of product types.
5
Products
Dual Licensed (ODbL & TGS license)
Description
products.description
A concise, objective statement explaining what the product does and who it is for.
5
Products
Dual Licensed (ODbL & TGS license)
Product Status
products.productStatusId
The current development or access stage of the product (e.g. Beta, Live, Deprecated).
5
Products
Dual Licensed (ODbL & TGS license)
Is Main product?
products.isMainProduct
A boolean value indicating whether the product is the Profile's primary or flagship offering.
5
Products
Dual Licensed (ODbL & TGS license)
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.
5
Products
Dual Licensed (ODbL & TGS license)
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.
5
Products
TGS license only
RootID
products.rootId
Products
assets
9
Name
assets.name
The official name of the Asset as used in its branding, marketing, and trading materials.
5
Assets
Dual Licensed (ODbL & TGS license)
Special TPIP
Ticker
assets.ticker
The unique trading symbol used to represent the Asset on exchanges and trading platforms. Use only capital letters and numbers.
5
Assets
Dual Licensed (ODbL & TGS license)
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.
5
Assets
Dual Licensed (ODbL & TGS license)
Special TPIP
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.
5
Assets
Dual Licensed (ODbL & TGS license)
Asset Type
assets.assetTypeId
The primary category or function of the Asset (e.g. Currency, Utility, Security) and what is does.
5
Assets
Dual Licensed (ODbL & TGS license)
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.
5
Assets
Dual Licensed (ODbL & TGS license)
Associated root
assets.rootId
A reference to the Profile associated with the Asset, using the Profile's unique identifier or name.
5
Assets
Dual Licensed (ODbL & TGS license)
Asset Status
assets.assetStatusId
The current development or access stage of the asset. Refer to the standardized list of asset status options.
7
Assets
Dual Licensed (ODbL & TGS license)
entities
12
Name
The legal name of the Entity as registered with the relevant regulatory bodies or government agencies.
5
Entities
Dual Licensed (ODbL & TGS license)
Trade Name
entities.tradeName
Any additional trading names, brands, or trademarks associated with the Entity, separate from its legal name.
5
Entities
Dual Licensed (ODbL & TGS license)
Type
entities.entityTypeId
The legal structure or registration category of the Entity (e.g. LLC, Foundation, Corporation).
5
Entities
TGS license only
Date of incorporation
entities.dateOfIncorporation
The date when the Entity was legally registered or incorporated. Use ISO 8601 format (YYYY-MM-DD) when possible.
5
Entities
TGS license only
Parent Entity
entities.parentEntity
A reference to the parent Entity, if applicable, using the parent Entity's unique identifier or name.
5
Entities
TGS license only
Reg number
entities.localRegistrationNumber
The registration number assigned to the Entity by the relevant regulatory body or government agency, if applicable.
5
Entities
TGS license only
Tax identification number
entities.taxIdentificationNumber
The unique tax identification number assigned to the Entity by the relevant tax authority, if applicable.
5
Entities
TGS license only
Address
entities.address
The registered physical address of the Entity, including street, city, state/province (if applicable), and postal code.
5
Entities
TGS license only
Country
entities.country
The country in which the Entity is legally registered or incorporated, using the ISO 3166-1 alpha-2 country code format.
5
Entities
Dual Licensed (ODbL & TGS license)
LEI Code
entities.leiNumber
The Legal Entity Identifier (LEI) code assigned to the Entity by the Global Legal Entity Identifier Foundation (GLEIF), if applicable.
5
Entities
TGS license only
RootID
entities.rootId
Entities
socials
4
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.
5
Socials
Dual Licensed (ODbL & TGS license)
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.
5
Socials
Dual Licensed (ODbL & TGS license)
Root ID
socials.rootId
7
Socials
roots
2
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.
5
TGS license only
tags
4
Name
The name of a tag which is a reference to something. This something is defined by its description and type.
6
TGS license only
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.
6
TGS license only
Description
tags.description
A description of this tag which provides a short explanation over what this unique tag is about
6
TGS license only
smartContractDeployments
4
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’.
7
Root
Dual Licensed (ODbL & TGS license)
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.
7
Root
Dual Licensed (ODbL & TGS license)
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.
7
Root
Dual Licensed (ODbL & TGS license)
smartContracts
5
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.
7
Root
Dual Licensed (ODbL & TGS license)
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.
7
Root
Dual Licensed (ODbL & TGS license)
Address
smartContracts.address
The unique blockchain address where the smart contract is deployed. Format must match the relevant blockchain's address structure.
7
Root
Dual Licensed (ODbL & TGS license)
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.
7
Root
Dual Licensed (ODbL & TGS license)
urls
5
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).
7
Dual Licensed (ODbL & TGS license)
URL
urls.url
This is a URL that links to different types, it must always start with a "http://" or "https://".
7
Dual Licensed (ODbL & TGS license)
Core Table
urls.tableId
7
Row
urls.rowId
7
productAssetRelationships
4
Product
productAssetRelationships.productId
A product entry that maintains a defined relationship with one or more assets through integration, display, or functional requirements.
7
TGS license only
Asset
productAssetRelationships.assetId
An asset entry that functions within a specific product through integration, serving purposes defined by its Asset Type parameter.
7
TGS license only
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.
7
TGS license only
assetStandards
3
Standard Description
assetStandards.definition
Detailed description of the standard's purpose and characteristics
assetStatuses
3
Status Description
assetStatuses.definition
Description of what this status means for an asset
assetSupportTypes
3
Support Type Description
assetSupportTypes.definition
Description of how this type of support functions between assets
productTypes
3
Product Type Description
productTypes.definition
Description of what this product type encompasses
assetTypes
3
Asset Type Description
assetTypes.definition
Description of what this type of asset represents
entityTypes
3
Entity Type Description
entityTypes.definition
Description of what this type of entity structure represents
productStatuses
3
Status Description
productStatuses.definition
Description of what this status means for a product
profileSectors
3
Sector Description
profileSectors.definition
Description of what this sector encompasses
profileStatuses
3
Status Description
profileStatuses.definition
Description of what this status means for a profile
profileTypes
3
Type Description
profileTypes.definition
Description of what this type of profile represents
socialTypes
3
Platform Description
socialTypes.definition
Description of the social media platform type
deploymentTypes
3
Deployment Description
deploymentTypes.definition
Description of what this deployment type represents
tagTypes
3
Tag Type Description
tagTypes.definition
Description of what this type of tag represents
urlTypes
3
URL Type Description
urlTypes.definition
Description of what this type of URL represents
countries
2
supportsProducts
3
Product
supportsProducts.productID
6
Supports Product
supportsProducts.supportsProductID
6
derivativeAssets
3
derivative Asset
derivativeAssets.derivativeAssetId
7
Base Asset
derivativeAssets.baseAssetId
7
productDeployments
3
Product
productDeployments.productId
7
Product Deployment Info
productDeployments.deploymentId
7
assetDeployments
3
Asset Deployment Info
assetDeployments.deploymentId
7
Asset
assetDeployments.assetId
7
Want to print your doc?
This is not the way.
This is not the way.
Try clicking the ⋯ next to your doc name or using a keyboard shortcut (
CtrlP
) instead.