API docs by Redocly

(0.0.0)

Download OpenAPI specification:Download

Bricks

DeployMedia

Deploy Media

Request Body schema: application/json
accessToken
required
string

Valid NCC access token

uuid
required
string

UUID of active NCC user

name
required
string

Name of media

metadata
required
string

Metadata of media

price
required
number

Price of media

publicPerformancePrice
required
number

Public performance price of media

creatorAddress
required
string

Creator's Algorand address

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "uuid": "string",
  • "name": "string",
  • "metadata": "string",
  • "price": 0,
  • "publicPerformancePrice": 0,
  • "creatorAddress": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "result": {
    },
  • "error": {
    }
}

ListBricks

List Bricks

Request Body schema: application/json
accessToken
required
string

Valid NCC access token

creatorAddress
required
string

Creator's Algonaut address

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "creatorAddress": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "result": {
    },
  • "error": {
    }
}

SendBricks

Send Bricks

Request Body schema: application/json
accessToken
required
string

Valid NCC access token

uuid
required
string

Active NCC user uuid

amount
required
number

Amount of Bricks to send

toAddress
required
string

Recipient address of transaction

toAppIndex
required
number

App index

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "uuid": "string",
  • "amount": 0,
  • "toAddress": "string",
  • "toAppIndex": 0
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "result": {
    },
  • "error": {
    }
}

SendRicks

Send Ricks

Request Body schema: application/json
accessToken
required
string

Valid NCC access token

uuid
required
string

Active NCC user uuid

amount
required
number

Amount of Ricks to send

toAddress
required
string

Recipient address of transaction

toAppIndex
required
number

App index

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "uuid": "string",
  • "amount": 0,
  • "toAddress": "string",
  • "toAppIndex": 0
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "result": {
    },
  • "error": {
    }
}

LiNR

LiNRMedia

LiNR Media

Request Body schema: application/json
accessToken
required
string

Valid NCC access token

qText
required
string

Question to ask LiNR

ctx
required
string

Context to provide LiNR

respLength
required
number

Length of response

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "qText": "string",
  • "ctx": "string",
  • "respLength": 0
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "result": {
    },
  • "error": {
    }
}

LiNRMusic

LiNR Music

Request Body schema: application/json
accessToken
required
string

Valid NCC access token

qText
required
string

Question to ask LiNR

ctx
required
string

Context to provide LiNR

respLength
required
number

Length of response

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "qText": "string",
  • "ctx": "string",
  • "respLength": 0
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "result": {
    },
  • "error": {
    }
}

Milestone

MilestoneValidateAdmin

Validates admin privileges for milestone

query Parameters
id
required
string

App index of milestone to check

Request Body schema: application/json
accessToken
required
string

Valid NCC access token

route
required
string

For this endpoint, route is 'isAdmin'

uuid
required
string

UUID of active NCC user

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "route": "string",
  • "uuid": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "result": {
    },
  • "error": {
    }
}

MilestoneCreate

Creates a new milestone

Request Body schema: application/json
accessToken
required
string

Valid NCC access token

route
required
string

For this endpoint, route is 'create'

uuid
required
string

UUID of active NCC user

creatorAddress
required
string

Algorand address of milestone creator

url
required
string

URL of new milestone

title
required
string

Title of new milestone

description
required
string

Description of new milestone

data
required
string

Data of new milestone

project_id
required
string

Project ID to associate new project

approverUUID
required
string

UUID of NCC user to be approver of milestone

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "route": "string",
  • "uuid": "string",
  • "creatorAddress": "string",
  • "url": "string",
  • "title": "string",
  • "description": "string",
  • "data": "string",
  • "project_id": "string",
  • "approverUUID": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "result": {
    },
  • "error": {
    }
}

MilestoneFetchByProject

Fetches all milestones by project

Request Body schema: application/json
accessToken
required
string

Valid NCC access token

route
required
string

For this endpoint, route is 'fetchByProjectId'

uuid
required
string

UUID of active NCC user

project_id
required
string

Project index associated with milestones to be fetched

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "route": "string",
  • "uuid": "string",
  • "project_id": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "result": {
    },
  • "error": {
    }
}

Org

FetchAllOrgs

Get all orgs

Request Body schema: application/json
accessToken
required
string

Valid NCC access token

uuid
required
string

Active NCC user uuid

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "uuid": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "result": {
    },
  • "error": {
    }
}

OrgUpdate

Updates an existing organization

query Parameters
name
required
string

Name of organization to update

Request Body schema: application/json
accessToken
required
string

Valid NCC access token

route
required
string

For this endpoint, route is 'update'

uuid
required
string

UUID of active NCC user

required
object

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "route": "string",
  • "uuid": "string",
  • "edits": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "result": {
    },
  • "error": {
    }
}

OrgCreate

Create new Rodeo organization

Request Body schema: application/json
orgName
required
string

Name of organization

url
required
string

Url of organization

description
required
string

Description of organization

totalMembers
required
string

Number of total members

totalAdmins
required
string

Number of total admins

accessToken
required
string

Valid NCC access token

creatorAddress
required
string

Algorand address of organization creator

Responses

Request samples

Content type
application/json
{
  • "orgName": "string",
  • "url": "string",
  • "description": "string",
  • "totalMembers": "string",
  • "totalAdmins": "string",
  • "accessToken": "string",
  • "creatorAddress": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "result": {
    },
  • "error": {
    }
}

OrgFetchByAppId

Fetch organization by app ID

query Parameters
appId
required
string

App index of organization to fetch

Request Body schema: application/json
accessToken
required
string

Valid NCC access token

route
required
string

The route value of this endpoint is 'fetchByAppId'

uuid
required
string

UUID of active NCC user

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "route": "string",
  • "uuid": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "result": {
    },
  • "error": {
    }
}

Peels

CreatePeels

Create peels contract

Request Body schema: application/json
accessToken
required
string

Valid NCC access token

name
required
string

Name of Peels contract

meta
required
string

Metadata

url
required
string

Associated URL

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "name": "string",
  • "meta": "string",
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": {
    }
}

FundsUser

Funds a user

Request Body schema: application/json
address
required
string

Address to be funded

contractId
required
string

Index of contract

challenge
required
string

Challenge

Responses

Request samples

Content type
application/json
{
  • "address": "string",
  • "contractId": "string",
  • "challenge": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "result": {
    },
  • "error": {
    }
}

GrantsPeel

Grants a Peel

Request Body schema: application/json
accessToken
required
string

Valid NCC access token

appId
required
number

App index of Peels

grantToAddress
required
string

Address of grantee

totalGrant
required
number

Total units to be granted

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "appId": 0,
  • "grantToAddress": "string",
  • "totalGrant": 0
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": {
    }
}

GrantsPeelToken

Grants Peel tokens

Request Body schema: application/json
accessToken
required
string

Valid NCC access token

appId
required
number

App index of Peels

grantToAddress
required
string

Address of grantee

tokenId
required
number

Index of toekn

totalTokens
required
number

Total tokens to be granted

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "appId": 0,
  • "grantToAddress": "string",
  • "tokenId": 0,
  • "totalTokens": 0
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": {
    }
}

ListAllPeels

List all Peels

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "data": [
    ]
}

ListPeels

List Peels

Request Body schema: application/json
accessToken
required
string

Valid NCC access token

creatorAddress
required
string

Address of Peels creator

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "creatorAddress": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

MintsPeel

Mints a Peel

Request Body schema: application/json
accessToken
required
string

Valid NCC access token

appId
required
number

App index of Peels

tokenName
required
string

Name of Peels

tokenUrl
required
string

URL of token

totalTokens
required
number

Number of total tokens

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "appId": 0,
  • "tokenName": "string",
  • "tokenUrl": "string",
  • "totalTokens": 0
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": {
    }
}

Project

ProjectVote

Votes on project

query Parameters
id
required
string

App index of project to vote on

Request Body schema: application/json
accessToken
required
string

Valid NCC access token

uuid
required
string

UUID of active NCC user

route
required
string

For this endpoint, route is 'vote'

vote
required
string

Value of vote

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "uuid": "string",
  • "route": "string",
  • "vote": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "result": {
    },
  • "error": {
    }
}

ProjectCreate

Creates a new project

Request Body schema: application/json
accessToken
required
string

Valid NCC access token

route
required
string

For this endpoint, route is 'create'

uuid
required
string

UUID of active NCC user

creatorAddress
required
string

Algorand address of project creator

url
required
string

URL of new project

title
required
string

Title of new project

description
required
string

Description of new project

org_id
required
string

Org ID to associate new project

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "route": "string",
  • "uuid": "string",
  • "creatorAddress": "string",
  • "url": "string",
  • "title": "string",
  • "description": "string",
  • "org_id": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "result": {
    },
  • "error": {
    }
}

ProjectFetchAllByOrg

Fetch all projects by organization ID

Request Body schema: application/json
accessToken
required
string

Valid NCC access token

route
required
string

For this endpoint, route is 'fetchByOrgId'

uuid
required
string

UUID of active NCC user

org_id
required
string

ID of organization

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "route": "string",
  • "uuid": "string",
  • "org_id": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "result": {
    },
  • "error": {
    }
}

TTM

ReceiveTTM

Receive TTM

Request Body schema: application/json
accessToken
required
string

Valid NCC access token

uuid
required
string

UUID of active NCC user

lastRound
required
number

Last blockchain round to search

required
object

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "uuid": "string",
  • "lastRound": 0,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "result": {
    },
  • "error": {
    }
}

SendTTM

Send TTM

Request Body schema: application/json
accessToken
required
string

Valid NCC access token

uuid
required
string

UUID of active NCC user

tokenToTarget
required
number

ASA ID of token to target

message
required
string

Message to send

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "uuid": "string",
  • "tokenToTarget": 0,
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "result": {
    },
  • "error": {
    }
}

Token

GetNCCs

Get NCCs

Request Body schema: application/json
address
required
string

Algorand address to receive testnet NCC tokens

Responses

Request samples

Content type
application/json
{
  • "address": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "result": {
    },
  • "error": {
    }
}

User2

GetAccessToken

Get access token

Request Body schema: application/json
address
required
string

Algorand address of user

txId
required
string

ID of signed atomic transaction to get NCC token

signedTx
required
string

Base64 encoded string of signed transaction

Responses

Request samples

Content type
application/json
{
  • "address": "string",
  • "txId": "string",
  • "signedTx": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "result": {
    },
  • "error": {
    }
}

User

DeRegisterUser

De-register a user account

Request Body schema: application/json
accessToken
required
string

Valid NCC access token

uuid
required
string

Active NCC user uuid to de-register

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "uuid": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "result": {
    },
  • "error": {
    }
}

DeregisterUser

Deregister an NCC user

Request Body schema: application/json
accessToken
required
string

Valid NCC access token

uuid
required
string

Active NCC user uuid to de-register

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "uuid": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "result": {
    },
  • "error": {
    }
}

FundUser

Fund a user account

Request Body schema: application/json
accessToken
required
string

Valid NCC access token

uuid
required
string

Active NCC user uuid to fund

asaId
required
number

ID of asset to fund, defaults to Algo

amount
required
number

Amount to fund user

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "uuid": "string",
  • "asaId": 0,
  • "amount": 0
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "result": {
    },
  • "error": {
    }
}

ListAccounts

List accounts

query Parameters
limit
required
string

Pagination limit, defaults to 10

page
required
string

Page, defaults to 1

Request Body schema: application/json
accessToken
required
string

Valid NCC access token

creatorAddress
required
string

Algorand address of creator

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "creatorAddress": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "result": {
    },
  • "error": {
    }
}

OptUserApp

Opt user account into app

Request Body schema: application/json
accessToken
required
string

Valid NCC access token

uuid
required
string

Active NCC user uuid to opt-in

appId
required
number

ID of app to opt-in

appArgs
required
string

Comma-separated string of app arguments, up to 8

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "uuid": "string",
  • "appId": 0,
  • "appArgs": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "result": {
    },
  • "error": {
    }
}

OptUserApp

Opt user account into app

Request Body schema: application/json
accessToken
required
string

Valid NCC access token

uuid
required
string

Active NCC user uuid to opt-in

appId
required
number

ID of app to opt-in

appArgs
required
string

Comma-separated string of app arguments, up to 8

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "uuid": "string",
  • "appId": 0,
  • "appArgs": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "result": {
    },
  • "error": {
    }
}

OptUserToken

Opt user account into token

Request Body schema: application/json
accessToken
required
string

Valid NCC access token

uuid
required
string

Active NCC user uuid to opt-in

asaId
required
number

ID of asset to opt-in, defaults to Algo

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "uuid": "string",
  • "asaId": 0
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "result": {
    },
  • "error": {
    }
}

OptUserToken

Opt user account into token

Request Body schema: application/json
accessToken
required
string

Valid NCC access token

uuid
required
string

Active NCC user uuid to opt-in

asaId
required
number

ID of asset to opt-in, defaults to Algo

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "uuid": "string",
  • "asaId": 0
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "result": {
    },
  • "error": {
    }
}

RegisterUser

Register a user account

Request Body schema: application/json
accessToken
required
string

Valid NCC access token

uuid
required
string

Active NCC user uuid

creatorAddress
required
string

Algorand address of creator

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "uuid": "string",
  • "creatorAddress": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "result": {
    },
  • "error": {
    }
}

RegisterUsers

Batch register user accounts

Request Body schema: application/json
accessToken
required
string

Valid NCC access token

creatorAddress
required
string

Algorand address of creator

csv
required
string

Base64 encoded CSV string of users to create

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "creatorAddress": "string",
  • "csv": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "result": {
    },
  • "error": {
    }
}