Create a new asset

POST 
https://api.sandbox.magfi.net/api/assets

Create a new asset in the system

Request

application/json

Bodyrequired

namestringrequired
Name of the asset
Possible values: <= 255 characters
Example: Bitcoin
labelstringrequired
Short label/symbol for the asset
Possible values: <= 255 characters
Example: BTC
unitNamestringrequired
Name of the unit
Possible values: <= 255 characters
Example: bitcoin
assetTypestringrequired
Type of the asset
Possible values: <= 255 characters
Default value: bitcoin
Example: bitcoin
maxDecimalPrecisionintegerrequired
Maximum number of decimal places
Example: 8

Responses

201

Asset created successfully

application/json

Schema

Schema

iduuid
namestring
Name of the asset
Possible values: <= 255 characters
Example: Bitcoin
labelstring
Short label/symbol for the asset
Possible values: <= 255 characters
Example: BTC
unitNamestring
Name of the unit
Possible values: <= 255 characters
Example: bitcoin
assetTypestring
Type of the asset
Possible values: <= 255 characters
Default value: bitcoin
Example: bitcoin
maxDecimalPrecisioninteger
Maximum number of decimal places
Example: 8
blockchainIdstring
ID of the blockchain
Possible values: <= 255 characters
Example: btc-mainnet
fireblocksAssetIdstring
Fireblocks asset identifier
Possible values: <= 255 characters
Example: BTC
globallyAvailableboolean
Whether the asset is globally available
Default value: false
innotrustIdstring
Innotrust identifier
Possible values: <= 255 characters
Example: INNO_BTC
internalboolean
Whether the asset is internal
Default value: false
requiresManualDepositboolean
Whether manual deposit is required
Default value: false
requiresTagboolean
Whether the asset requires a tag
Default value: false
singleUnitboolean
Whether the asset is a single unit
Default value: false
supportFireblocksIncomingAddressboolean
Whether Fireblocks incoming addresses are supported
Default value: false
transferableboolean
Whether the asset can be transferred
Default value: true
createdAtdate-time
updatedAtdate-time

Example (auto)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Bitcoin",
  "label": "BTC",
  "unitName": "bitcoin",
  "assetType": "bitcoin",
  "maxDecimalPrecision": 8,
  "blockchainId": "btc-mainnet",
  "fireblocksAssetId": "BTC",
  "globallyAvailable": false,
  "innotrustId": "INNO_BTC",
  "internal": false,
  "requiresManualDeposit": false,
  "requiresTag": false,
  "singleUnit": false,
  "supportFireblocksIncomingAddress": false,
  "transferable": true,
  "createdAt": "2024-07-29T15:51:28.071Z",
  "updatedAt": "2024-07-29T15:51:28.071Z"
}

400

Bad Request - Invalid input data

application/json

Schema

Schema

messagestringrequired

Error message

descriptionstring

Detailed error description

codestring

Error code

Example (auto)

{
  "message": "Invalid input data",
  "description": "The request data did not pass validation",
  "code": "INVALID_INPUT"
}

401

Unauthorized - Invalid or missing authentication token

application/json

Schema

Schema

messagestringrequired

Error message

descriptionstring

Detailed error description

codestring

Error code

Example (auto)

{
  "message": "Unauthorized",
  "description": "Invalid, expired or missing bearer token",
  "code": "UNAUTHORIZED"
}

403

Forbidden - Insufficient permissions

application/json

Schema

Schema

messagestringrequired

Error message

descriptionstring

Detailed error description

codestring

Error code

Example (auto)

{
  "message": "Forbidden",
  "description": "You don't have permission to access this resource",
  "code": "FORBIDDEN"
}

404

Not Found - Resource not found

application/json

Schema

Schema

messagestringrequired

Error message

descriptionstring

Detailed error description

codestring

Error code

Example (auto)

{
  "message": "Resource not found",
  "description": "The requested resource could not be found",
  "code": "NOT_FOUND"
}

409

Conflict - Resource already exists or state conflict

application/json

Schema

Schema

messagestringrequired

Error message

descriptionstring

Detailed error description

codestring

Error code

Example (auto)

{
  "message": "Resource conflict",
  "description": "The resource already exists or is in an invalid state",
  "code": "CONFLICT"
}

422

Unprocessable Entity - Validation error

application/json

Schema

Schema

messagestringrequired

Error message

descriptionstring

Detailed error description

codestring

Error code

Example (auto)

{
  "message": "Validation error",
  "description": "The request data failed validation rules",
  "code": "VALIDATION_ERROR"
}

• javascript
• python
• curl
• rust
• go
• java
• ruby

• FETCH
• JQUERY
• XHR

const myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Accept", "application/json");

const raw = JSON.stringify({
  "name": "Bitcoin",
  "label": "BTC",
  "unitName": "bitcoin",
  "assetType": "bitcoin",
  "maxDecimalPrecision": 8
});

const requestOptions = {
  method: "POST",
  headers: myHeaders,
  body: raw,
  redirect: "follow"
};

fetch("https://api.sandbox.magfi.net/api/assets", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

Request Collapse all

Base URL

https://api.sandbox.magfi.net/api

Body required

{
  "name": "Bitcoin",
  "label": "BTC",
  "unitName": "bitcoin",
  "assetType": "bitcoin",
  "maxDecimalPrecision": 8
}

ResponseClear

Click the Send API Request button above and see the response here!