Skip to main content

/v1/collections/{id} REST API Endpoint

Returns the collection by providing the collection ID.

Updated on
Oct 4, 2023

/v1/collections/{id} REST API Endpoint

Parameters

id
string
REQUIRED
The id of the collection
expand
string
A comma-separated list indicating which properties of the content to expand
select
string
A comma-separated list indicating which properties of the content to return

Returns

id
string
The id of the collection
transactions
array
The transaction object with the following fields:
id
string
The ID of the transaction
script
string
The Base64 encoded content of the Cadence script
arguments
array
A list of arguments each encoded as Base64 passed in the JSON-Cadence interchange format
reference_block_id
string
The reference block ID for the transaction
gas_limit
string
The limit on the amount of computation a transaction is allowed to perform
payer
string
The 8-byte address of an account
proposal_key
object
It contains information about the account that proposed the transaction. It contains the following fields:
address
string
The address of the account that proposed the transaction
key_index
string
The index of the key used by the account to sign the transaction proposal
sequence_number
string
The current sequence number of the account that proposed the transaction
authorizers
array
An array of addresses for the accounts that have authorized the transaction
payload_signatures
array
It contains an array of signatures for the transaction payload. Each signature is associated with a specific key, identified by the following fields:
address
string
The address of the account that owns the key used to sign the payload
key_index
string
The index of the key used to sign the payload
signature
string
The digital signature generated by the key for the payload
envelope_signatures
array
An array of signatures for the transaction envelope. Each signature is associated with a specific key, identified by the following fields:
address
string
The address of the account that owns the key used to sign the envelope
key_index
string
The index of the key used to sign the envelope
signature
string
The digital signature generated by the key for the envelope
result
object
The result object which contains the following fields:
block_id
string
The ID of the block that contains the transaction
execution
string
It indicates whether the transaction execution has been completed or is still pending
status
string
The overall status of the transaction execution
status_code
integer
The numeric code associated with the transaction execution status
error_message
string
The message indicating any errors that occurred during transaction execution
computation_used
string
The amount of computation used by the transaction
events
array
An array of events that were emitted during the execution of the transactions. It contains the following fields:
type
string
The type of the event, which is typically a string that identifies the purpose or function of the event
transaction_id
string
The unique id of the transaction that emitted the event
transaction_index
string
The index of the transaction that emitted the event
event_index
string
The index of the event within the transaction
payload
string
The data payload associated with the event, which can be used to provide additional information about the event
_links
object
An object that contains links to related resources or endpoints
_self
string
It is a link that refers to the current resource itself. In this case, it is the transaction resource requested
_expandable
object
If _expandable is present in the response, it can be used to make an additional request to expand the result field and retrieve more information
result
string
The result associated with the transaction
_links
object
An object that contains links to related resources or endpoints
_self
string
It is a link that refers to the current resource itself. In this case, it is the transaction resource requested
_expandable
object
The items inside the _expandable object can be expanded by passing as the query parameter in the request. For this method, the parameter transactions has been added to the request
_links
object
An object that contains links to related resources or endpoints
_self
string
It is a link that refers to the current resource itself. In this case, it is the collection resource requested
Request
1
curl -X 'GET' 'https://docs-demo.flow-mainnet.quiknode.pro/v1/collections/34716bf48d2f59a7ec24339c74c5ad4ad77e5a6efdc4420ed09fef76fe39c5e9?expand=transactions' \
2
--header 'Content-Type: application/json'
Don't have an account yet?
Create your QuickNode endpoint in seconds and start building
Get started for free