Projects

Projects​

This is the only section that requires user signatures - specifically, project owner signatures. This is because only project owners can list projects they own, or get details about each one. Follow this guide to generate the signers required to obtain user signatures.

Get list of projects

• Typescript Core SDK

📚SDK REFERENCE

• getProjects

• Kotlin (JVM) Core SDK

• Swift Core SDK

• Golang Core SDK

Request​

Get the list of projects belonging to the signer account.

const getProjects = async (ethSigner: EthSigner) => {
  const response = await client.getProjects(ethSigner);
  return response;
};

getProjects(ethSigner)
  .then((result) => {
    console.log(result);
  })
  .catch((e) => {
    console.log(e);
  });

Example response​

{
  result: [
    {
      id: 145, // The project ID
      name: 'Test writer guild', // The project name
      company_name: 'Test XpansionChain company', // The company name
      contact_email: '[e-mail]', // The project contact email
      mint_remaining: 0, // The number of mint operation remaining in the current period
      mint_limit_expires_at: '2022-10-01T17:41:44.650487Z', // The current period expiry date for mint operation limit
      mint_monthly_limit: 0,  // The total monthly mint operation limit
      collection_remaining: 0, // The number of collection remaining in the current period
      collection_limit_expires_at: '2022-10-01T17:41:44.650487Z', // The current period expiry date for collection
      collection_monthly_limit: 0 // The total monthly collection limit
    },
   // Other projects returned
    ...
  ],
  cursor: 'eyJwcm9qZWN0X2lkIjoxNDUsIm5hbWUiOiJUZXN0IHdyaXRlciBndWlsZCIsImNvbXBhbnlfbmFtZSI6IlRlc3QgSW1tdXRhYmxlIGNvbXBhbnkiLCJjb250YWN0X2VtYWlsIjoiaW1tdXRhYmxldGVzdEBleGFtcGxlLmNvbSIsIm1pbnRfcmVtYWluaW5nIjowLCJtaW50X2xpbWl0X2V4cGlyZXNfYXQiOiIyMDIyLTEwLTAxVDE3OjQxOjQ0LjY1MDQ4N1oiLCJtaW50X21vbnRobHlfbGltaXQiOjAsImNvbGxlY3Rpb25fcmVtYWluaW5nIjowLCJjb2xsZWN0aW9uX2xpbWl0X2V4cGlyZXNfYXQiOiIyMDIyLTEwLTAxVDE3OjQxOjQ0LjY1MDQ4N1oiLCJjb2xsZWN0aW9uX21vbnRobHlfbGltaXQiOjB9',
  // Remaining results
  remaining: 0
}

Kotlin (JVM) Core SDK

📚SDK REFERENCE

• getProjects

swift core SDK

📚SDK REFERENCE

• getProjects

Golang Core SDK

• GetProjects

📚SDK REFERENCE

Get details about a project​

• Typescript Core SDK

📚SDK REFERENCE

• getProject

Request​

Get details about a project with a given ID:

const getProject = async (ethSigner: EthSigner, id: string) => {
  const response = await client.getProject(ethSigner, id);
  return response;
};
getProject(ethSigner, '145')
  .then((result) => {
    console.log(result);
  })
  .catch((e) => {
    console.log(e);
  });

Example response​

{
    id: 145, // The project ID
    name: 'Test writer guild', // The project name
    company_name: 'Test XpansionChain company', // The company name
    contact_email: '[e-mail]', // The project contact email
    mint_remaining: 0, // The number of mint operation remaining in the current period
    mint_limit_expires_at: '2022-10-01T17:41:44.650487Z', // The current period expiry date for mint operation limit
    mint_monthly_limit: 0,  // The total monthly mint operation limit
    collection_remaining: 0, // The number of collection remaining in the current period
    collection_limit_expires_at: '2022-10-01T17:41:44.650487Z', // The current period expiry date for collection
    collection_monthly_limit: 0 // The total monthly collection limit
}

• Kotlin (JVM) Core SDK

📚SDK REFERENCE

• getProject

• Swift Core SDK

📚SDK REFERENCE

• getProject

• Golang Core SDK

SDK REFERENCE

• GetProject

See GetProject example from our SDK repo.