Marketplace api

[ybensacq]

Model of marketplace api

Tables

Contract Table

This table stores information about contracts.

Field	Type	Description
contract_id	INTEGER	Unique identifier for the contract.
chain_id	INTEGER	Identifier for the network where it's deployed.
updated	TIMESTAMP	Timestamp of the last update.
contract_address	VARCHAR	The blockchain address of the contract.
floor_price	DECIMAL	The lowest price at which a piece can be bought.
top_bid	DECIMAL	The highest bid currently placed on items.
contract_type	ENUM	The type of the contract (e.g., erc721).
contract_name	VARCHAR	The name of the contract.
contract_symbol	VARCHAR	The symbol used to represent the contract.
contract_image	VARCHAR	URL to an image representing the contract.
metadata_ok	BOOLEAN	Indicates if the contract's metadata has been sync.
is_spam	BOOLEAN	Flags the contract as potential spam.
is_nsfw	BOOLEAN	Indicates if the contract contains NSFW content.

Token Table

This table tracks the buying process for tokens, including listings, bids, and ownership changes.

Field	Type	Description
buy_in_progress	BOOLEAN	Indicates if the buy process is currently active.
token_id	INTEGER	Token id.
contract_id	INTEGER	Foreign key to the Contract table.
current_owner	VARCHAR	Address of the current owner.
has_bid	BOOLEAN	Indicates if there is an active bid.
held_timestamp	TIMESTAMP	Timestamp when the token was last held.
is_listed	BOOLEAN	Indicates if the token is currently listed for sale.
last_price	DECIMAL	The last sale price of the token.
listing_currency_address	VARCHAR	Address of the currency used for listing.
listing_currency_chain_id	INTEGER	Chain ID of the currency used for listing.
listing_timestamp	TIMESTAMP	Timestamp when the token was listed.
listing_broker_id	INTEGER	Identifier of the broker that listed the token.
listing_orderhash	VARCHAR	Hash of the order for listing the token.
listing_end_amount	DECIMAL	The final amount for which the listing is set to end.
listing_end_date	DATE	Date when the listing is set to end.
metadata	JSON	JSON blob holding metadata about the token.
metadata_status	VARCHAR	Status of the metadata (valid, invalid, pending, etc.).
quantity	INTEGER	Quantity of the tokens being bought/sold.
start_amount	DECIMAL	Starting amount for the listing.
start_date	DATE	Date when the listing starts.
status	VARCHAR	Current status of the buy process
token_id	INTEGER	Identifier of the token.
token_chain_id	INTEGER	Chain ID of the token.
token_id_hex	VARCHAR	Hexadecimal representation of the token ID.
top_bid_amount	DECIMAL	Amount of the top bid.
top_bid_broker_id	INTEGER	Broker ID of the top bid.
top_bid_order_hash	VARCHAR	Hash of the top bid order.
updated_timestamp	TIMESTAMP	Timestamp of the last update to the buy process.
is_burned	BOOLEAN	Indicates if the token has been burned.

Relationships

• contract_id is a foreign key that links to the Contract table
• The composite primary key (contract_id, token_id) ensures that each token from a specific contract has a unique representation

TokenOffers Table

This table captures the details of offers made on tokens.

Field	Type	Description
offer_id	INTEGER	Unique identifier for the offer.
token_id	INTEGER	Identifier of the token the offer is made on.
token_address	VARCHAR	The blockchain address of the token.
order_hash	VARCHAR	Unique hash of the order associated with the offer.
offer_maker	VARCHAR	Address of the user making the offer.
offer_amount	DECIMAL	The amount of currency offered.
offer_quantity	INTEGER	The quantity of tokens the offer is for.
offer_timestamp	TIMESTAMP	Timestamp when the offer was made.
currency_chain_id	INTEGER	Chain ID of the currency used for the offer.
currency_address	VARCHAR	Address of the currency used for the offer.
start_date	DATE	Date when the offer starts.
end_date	DATE	Date when the offer ends.
status	VARCHAR	Current status of the offer

TokenEvents Table

This table records significant events that tokens undergo in the marketplace, such as listings, offers, transfers, and more. Each row represents an event related to a specific token.

Field	Type	Description
event_id	INTEGER	Unique identifier for the event.
contract_address	VARCHAR	The blockchain address of the contract.
event_type	ENUM	Type of the event (e.g., Listing, Offer, Transfer).
timestamp	TIMESTAMP	Timestamp when the event occurred.
token_id	INTEGER	Identifier of the token involved in the event.
token_id_hex	VARCHAR	Hexadecimal representation of the token ID.
transaction_hash	VARCHAR	Hash of the transaction associated with the event.
to_address	VARCHAR	Blockchain address of the recipient in the event.
from_address	VARCHAR	Blockchain address of the sender in the event.
amount	DECIMAL	Amount of currency or number of tokens involved.
canceled_reason	VARCHAR	Reason the event was canceled, if applicable.

Event Types

The event_type column categorizes the nature of the event and can include:

• Listing: When a token is listed for sale.
• CollectionOffer: An offer made on a collection of tokens.
• Offer: An offer made on a single token.
• Auction: When a token is put up for auction.
• Fulfill: Event in progress.
• Cancelled: When an event (e.g., offer, listing) is canceled.
• Executed: Indicates a completed buy or sell transaction.
• Mint: When a new token is created.
• Burn: When a token is burned.
• Transfer: When a token is transferred from one address to another.

Block Table

This table contains information about blockchain blocks as they are indexed. It tracks the block number, the status of the indexing process, and other relevant metadata.

Field	Type	Description
block_number	INTEGER	Unique identifier for the block (Primary Key).
indexer_identifier	VARCHAR	Identifier for the indexer that processed the block.
indexer_version	VARCHAR	Version of the indexer software that processed the block.
status	ENUM	Status of the block processing (e.g., Pending, Completed).
timestamp	TIMESTAMP	Timestamp when the block was processed.