Home | API

Entities

Endpoints

List All Entities

The paginated API is used to query for multiple entities. You can apply filters through the query parameter to search for specific entities.

Endpoint

GET

Query Parameters

Name page
Description
The number of the page that will be returned.
Required No
Example 1
Name limit
Description
The number of resources per page.
Required No
Example 100
Name id
Description
The entity id to be retrieved.
Required No
Example
Name address
Description
The address for which entities are to be retrieved.
Required No
Example
Name publicKey
Description
The public key for which entities are to be retrieved.
Required No
Example
Name isResigned
Description
The flag to indicate that resigned entites should be retrieved.
Required No
Example
Name type
Description
The type of entities to be retrieved.
Required No
Example
Name subType
Description
The sub-type of entities to be retrieved.
Required No
Example
Name data.name
Description
The name of the entities to be retrieved.
Required No
Example
Name data.ipfsData
Description
The IPFS Hash of the entities to be retrieved.
Required No
Example

Retrieve an Entity

Specific entities can be retrieved by the ID of their registration transaction.

Endpoint

GET

Path Parameters

Name id
Description
The identifier of the registration transaction of the entity to be retrieved.
Required No
Example
2020 © ARK.io | All rights reserved An ARK.io Product