Changelogs
version | time | content |
---|---|---|
V1.0.0 | 2022-07-05 |
initial version |
Introduction
Communication Protocol
HTTPS Protocol.
Encoding
The request and response data code for all interfaces is formatted according to UTF-8. Content for responses in all interfaces is formatted according to JSON.
API Request Structure
Name | Description | Notes |
---|---|---|
API Address | Address for API interface | Eg. https://mapi.matrixport.com/smart-trend/api/v2/products |
Public Parameters | Universal parameters for all interfaces | |
Private Parameter | Special parameters for each interface | See each API interface description for details |
API hosts (production)
- REST API:
https://mapi.matrixport.com
API hosts (beta)
- REST API:
https://pre-mapi.matrixport.vip
Public Parameters
Public parameters are used for interface authentication. Unless otherwise necessary, these parameters will be omitted for each interface. Each request must contain these parameters unless stated otherwise.
Parameter Name | Type | Mandatory | Limit | Description |
---|---|---|---|---|
X-MatrixPort-Access-Key | string | Y | 32 | Access-Key given to users is contained within the http header. |
X-MatrixPort-Access-Signature | string | Y | - | Request signature is used to authorize the legitimacy of the request. Contained within the http header. |
timestamp | int64 | Y | - | Millisecond timestamp is contained within the http query param or body. |
language-type | int | Y | - | Language type within the interface will return according to: 0=CN, 1=EN, 2= RU |
x-request-id | string | N | - | Globally unique trace id, used for tracing requests |
Response Format Strings
All interface response values are formatted according to JSON. Unless otherwise stated, all request return values contain the following text strings:
Parameter Name | Type | Description |
---|---|---|
code | int | Interface call status, (ie. error code): 0: Normal, Others: Call error. |
message | string | Error message is description of API errors |
data | object | Results will return as defined by each interface |
Authentication
Smart-Trend API
Products List
Interface Description
- view the smart-trend products
GET
/smart-trend/api/v2/products
Request Parameters
- Request Parameter Location: query_string
Parameter Name | Type | Mandatory | Limit | Description |
---|---|---|---|---|
currency | string | N | 64 | Available currency: USDT, USDC, BTC, ETH, DAI, DOGE, DOT, LTC. Empty values indicate products for all currencies |
main_product_types | integer | N | - | trend type: 11:ETH Bull, 12:ETH Bear, 13:BTC Bull, 14:BTC Bear, 15:BCH Bull, 16:BCH Bear, . |
offset | integer | N | - | Offset is 0 by default. |
limit | integer | N | - | Page limit is 10 lines by default. |
- Response Results
- Response string is as follows. General string text has been omitted. See Response Format Strings for more details:
- Data Structure & Description:
curl "https://mapi.matrixport.com/smart-trend/api/v2/products?currency=USDT×tamp=1627021721000&signature=d58a54d7921187bf81a0e9d028cf460f70c3c83faba7f0e9abee054e7f7bfcd1"
{
"code": 0,
"message": "",
"data": {
"count": 23, //integer, query amount; Return amount is set according to the offset and limit
"items": [
//array,items
{
"id": "6820591484295766016", //string,, Product id
"renew_type": 0, //integer, Can you auto-renew?; 0: No 1: Yes
"currency": "USDT", //string,, Investment currency
"minimum_of_purchase_amount_dec": "100", //decimal, Minimum single transaction amount;
"maximum_of_purchase_amount_dec": "1000", //decimal, Maximum single transaction amount,
"user_purchase_limit_dec": "1000", //decimal, Maximum single user purchase amount,
"can_redeem": 0, //integer, Can you redeem early?;0: No 1: Yes
"redeem_ror": 0, //integer, Annual interest for early redemption, e8
"ror": 12000000, //integer, Annual interest, e8, 12% annual interest
"status": 2, //integer, Product status: 1: Pending 2: Available 3: Sold out 4: Outdated(can not buy)
"agreements": null, //array, Product protocol; See Product Interface details on structure definition;
"tags": [
//array, Product Label (Displays behind product name to entice users to purchase,. For example, "Redeem Early", "Star Product")
{
"id": 5216, //integer, Label ID
"deleted_at": null, //integer,Deletion Time
"product_id": "6820591484295766016", //string, Product ID
"language": "zh-CN", //string, Product Language
"tag": "High interest", //string, Label Content
},
],
"i18n": [
//array, Multilingual Product Info
{
"id": 19004, //integer, Multilingual ID
"product_id": "6820591484295766016", //string, Product ID
"language": "zh-CN", //string, Language
"name": "USDT Fixed Interest M0121", //string, Product name
"introduction": "Fixed Interest Product", //string, Product Info
"basic_rule":
"Minimum purchase amount is set to 100 USDT;Cannot redeem early ", //string, Basic Rules
},
],
"duration": {
"close_day": 3, //integer, Close Days, Unit: Days
"value_day": 0, //integer, Value Date: T+x, Unit: Days
"value_time": 64800, //integer, Value Time: 12:00 is 12*3600
"value_limit": 0, //integer, Interest Limit;0: No limit,1: Excludes weekends
"end_settled_day": 0, //integer, Closing Date for Settlement, T+x
"end_settled_time": 68400, //integer, Closing Time for Settlement: 12:00 is 12*3600
"settle_limit": 0, //integer, Settlement Limit;0: No limit,1:Excludes weekends
},
"fund_investments": null, //array, Funds destination; Product list does not return this data string. View the Product Info Interface for structural information.
"is_for_new_user": false, //boolean, Is it a product for new users?
"raised_time": 1626170400, //integer, Raise End Time
"start_closed_time": 1626170400, //integer, Close Start Time
"end_closed_time": 1626429600, //integer, Close End Time
"end_settled_time": 1626433200, //integer, Closing Time for Settlement
},
],
}
}
Parameter Name | Type | Description |
---|---|---|
count | integer | query amount; Return amount is set according to the offset and limit |
items | array | items |
items.id | string | Product id |
items.renew_type | integer | Can you auto-renew?; 0: No 1: Yes |
items.currency | string | Investment currency |
items.minimum_of_purchase_amount_dec | decimal | Minimum single transaction amount; |
items.maximum_of_purchase_amount_dec | decimal | Maximum single transaction amount |
items.user_purchase_limit_dec | decimal | Maximum single user purchase amount |
items.can_redeem | integer | Can you redeem early?;0: No 1: Yes |
items.redeem_ror | integer | Annual interest for early redemption, e8 |
items.ror | integer | Annual interest, e8, 12% annual interest |
items.status | integer | Product status: 1: Pending 2: Available 3: Sold out 4: Outdated(can not buy) |
items.agreements | array | Product protocol; See Product Interface details on structure definition; |
items.tags | array | Product Label (Displays behind product name to entice users to purchase,. For example, "Redeem Early", "Star Product") |
items.tags.id | integer | Label ID |
items.tags.deleted_at | integer | Deletion Time |
items.tags.product_id | string | Product ID |
items.tags.language | string | Product Language |
items.tags.tag | string | Label Content |
items.i18n | array | Multilingual Product Info |
items.i18n.id | integer | Multilingual ID |
items.i18n.product_id | string | Product ID |
items.i18n.language | string | Language |
items.i18n.name | string | Product name |
items.i18n.introduction | string | Product Info |
items.i18n.basic_rule | string | Basic Rules |
items.duration.close_day | integer | Close Days, Unit: Days |
items.duration.value_day | integer | Value Date: T+x, Unit: Days |
items.duration.value_time | integer | Value Time: 12:00 is 12*3600 |
items.duration.value_limit | integer | Interest Limit;0: No limit,1: Excludes weekends |
items.duration.end_settled_day | integer | Closing Date for Settlement, T+x |
items.duration.end_settled_time | integer | Closing Time for Settlement: 12:00 is 12*3600 |
items.duration.settle_limit | integer | Settlement Limit;0: No limit,1:Excludes weekends |
items.fund_investments | array | Funds destination; Product list does not return this data string. View the Product Info Interface for structural information. |
items.is_for_new_user | boolean | Is it a product for new users? |
items.raised_time | integer | Raise End Time |
items.start_closed_time | integer | Close Start Time |
items.end_closed_time | integer | Close End Time |
items.end_settled_time | integer | Closing Time for Settlement |
Product Detail
Interface Details:
- display information for a single smart-trend product.
GET
/smart-trend/api/v2/product
Request Parameters
- Request Parameter Location: query_string
Parameter Name | Type | Mandatory | Limit | Description |
---|---|---|---|---|
product_id | string | Y | 64 | Product ID: 6820591484295766016 |
- Response Results:
- Response strings are as follows. General string text has been omitted. Please see Response Format Strings for more details.
- Data Structure & Description:
curl "https://mapi.matrixport.com/smart-trend/api/v2/product?product_id=xxxx×tamp=1627021721000&signature=d58a54d7921187bf81a0e9d028cf460f70c3c83faba7f0e9abee054e7f7bfcd1"
{
"code": 0,
"message": "",
"data": {
"id": "6820591484295766016", //string, Product id
"renew_type": 0, //integer, Can you auto-renew?; 0: No 1: Yes
"currency": "USDT", //string, Investment Currency
"minimum_of_purchase_amount_dec": "100", //decimal, Minimum single transaction amount; initial investment amount,
"maximum_of_purchase_amount_dec": "1000", //decimal, Maximum single transaction amount,
"user_purchase_limit_dec": "1000", //decimal, Maximum single user purchase amount,
"can_redeem": 0, //integer, Can you redeem early?;0: No 1: Yes
"redeem_ror": 0, //integer, Redeem annual interest early, e8
"ror": 12000000, //integer, Annual interest, e8 12% annual interest
"status": 2, //integer, Product status: 1: Pending 2: Available 3: Sold out 4: Outdated(can not buy)
"agreements": [
{
"id": 11766, //integer, agreement id
"product_id": "6820591484295766016", //string, Product id
"agreement": "abs123456" //string, agreement name
}
],
"tags": [
{
"id": 5216, //integer, Label ID
"deleted_at": null, //string, Product ID
"product_id": "6820591484295766016",//string, Product id
"language": "zh-CN", //string, Product Language
"tag": "High revenue" //string, Label Content
},
],
"i18n": [ //array, Multilingual Product Info
{
"id": 19006, //integer, Multilingual ID
"product_id": "6820591484295766016", //string, Product ID
"language": "en", //string, Language
"name": "USDT Fixed-Term M012111", //string, Product Name
"introduction": "10086", //string, Product Info
"basic_rule": "10086" //string, Basic Rules
},
],
"duration": {
"close_day": 3, //integer, Close Days, Unit: Days
"value_day": 0, //integer, Close Days, Unit: Days
"value_time": 64800, //integer, Value Time: 12:00 is 12*3600
"value_limit": 0, //integer, Interest Limit;0: No limit, 1: Excludes weekends
"end_settled_day": 0, //integer, Closing Date for Settlement, T+x
"end_settled_time": 68400, //integer, Closing Time for Settlement: 12:00 is 12*3600
"settle_limit": 0 //integer, Settlement Limit;0: No limit, 1: Excludes weekends
},
"fund_investments": [
{
"id": 764, //integer, Investment Destination ID
"product_id": "6820591484295766016", //string, Product ID
"language": "en", //string, Language
"fund_investment": "Investment Destination Info (EN)" //string, Investment Destination Info
},
],
"option_portfolio":{
"options": [{ //array, options
"strike_price": 3100000000000, //integer, strike_price of option, e8 int
"underlying": "BTC", //integer, underlying of option
"strike_price_ror": 2500000, //integer, ror of option, e8 int
}, {
"strike_price": 5000000000000,
"underlying": "BTC",
"strike_price_ror": 34100000,
}],
}
"is_for_new_user": false, //boolean, is for new user
"raised_time": 1626170400, //integer, Raise End Time
"start_closed_time": 1626170400, //integer, Close Start Time
"end_closed_time": 1626429600, //integer, Close End Time
"end_settled_time": 1626433200 //integer, Closing Time for Settlement
}
}
Parameter Name | Type | Description |
---|---|---|
id | string | Product id |
renew_type | integer | Can you auto-renew?; 0: No 1: Yes |
currency | string | Investment Currency |
minimum_of_purchase_amount_dec | decimal | Minimum single transaction amount; initial investment amount |
maximum_of_purchase_amount_dec | decimal | Maximum single transaction amount |
user_purchase_limit_dec | decimal | Maximum single user purchase amount |
can_redeem | integer | Can you redeem early?;0: No 1: Yes |
redeem_ror | integer | Redeem annual interest early, e8 |
ror | integer | Annual interest, e8 12% annual interest |
status | integer | Product status: 1: Pending 2: Available 3: Sold out 4: Outdated(can not buy) |
agreements.id | integer | agreement id |
agreements.product_id | string | Product id |
agreements.agreement | string | agreement name |
tags.id | integer | Label ID |
tags.deleted_at | string | Product ID |
tags.product_id | string | Product id |
tags.language | string | Product Language |
tags.tag | string | Label Content |
i18n | array | Multilingual Product Info |
i18n.id | integer | Multilingual ID |
i18n.product_id | string | Product ID |
i18n.language | string | Language |
i18n.name | string | Product Name |
i18n.introduction | string | Product Info |
i18n.basic_rule | string | Basic Rules |
duration.close_day | integer | Close Days, Unit: Days |
duration.value_day | integer | Close Days, Unit: Days |
duration.value_time | integer | Value Time: 12:00 is 12*3600 |
duration.value_limit | integer | Interest Limit;0: No limit, 1: Excludes weekends |
duration.end_settled_day | integer | Closing Date for Settlement, T+x |
duration.end_settled_time | integer | Closing Time for Settlement: 12:00 is 12*3600 |
duration.settle_limit | integer | Settlement Limit;0: No limit, 1: Excludes weekends |
fund_investments.id | integer | Investment Destination ID |
fund_investments.product_id | string | Product ID |
fund_investments.language | string | Language |
fund_investments.fund_investment | string | Investment Destination Info |
is_for_new_user | boolean | is for new user |
raised_time | integer | Raise End Time |
start_closed_time | integer | Close Start Time |
end_closed_time | integer | Close End Time |
end_settled_time | integer | Closing Time for Settlement |
option_portfolio.options | array | options |
option_portfolio.options.strike_price | integer | strike_price of option, e8 int |
option_portfolio.options.underlying | integer | underlying of option |
option_portfolio.options.strike_price_ror | integer | ror of option, e8 int |
Options
Interface Details:
- return the options behind smart-trend products.
GET
/smart-trend/api/v2/options
Request Parameters
- Request Parameter Location: query_string
Parameter Name | Type | Mandatory | Limit | Description |
---|---|---|---|---|
product_id | string | Y | 64 | Product ID: 6820591484295766016 |
- Response Results
- Response strings are as follows. General string text has been omitted.
- Data Structure & Description:
curl "https://mapi.matrixport.com/smart-trend/api/v2/options?product_id=xxxx×tamp=1627021721000&signature=d58a54d7921187bf81a0e9d028cf460f70c3c83faba7f0e9abee054e7f7bfcd1"
{
"code": 0,
"data": {
"options": [{ // array, options
"strike_price": 3100000000000, // integer, strike_price of option, e8 int
"underlying": "BTC", // integer, underlying of option
"strike_price_ror": 2500000, // integer, ror of option, e8 int
}, {
"strike_price": 5000000000000,
"underlying": "BTC",
"strike_price_ror": 34100000,
}],
},
"message": ""
}
Parameter Name | Type | Description |
---|---|---|
options | array | options |
options.strike_price | integer | strike_price of option, e8 int |
options.underlying | integer | underlying of option |
options.strike_price_ror | integer | ror of option, e8 int |
Remaining Quota
Interface Details:
- return the quota for smart-trend products.
GET
/smart-trend/api/v2/product/quota
Request Parameters
- Request Parameter Location: query_string
Parameter Name | Type | Mandatory | Limit | Description |
---|---|---|---|---|
product_id | string | Y | 64 | Product ID: 6820591484295766016 |
- Response Results
- Response strings are as follows. General string text has been omitted.
- Data Structure & Description:
curl "https://mapi.matrixport.com/smart-trend/api/v2/product/quota?product_id=xxxx×tamp=1627021721000&signature=d58a54d7921187bf81a0e9d028cf460f70c3c83faba7f0e9abee054e7f7bfcd1"
{
"code": 0,
"message": "",
"data": {
"product_left_quota_dec": "1000", //decimal, Products remaining;-1 indicates no limit
"user_left_quota_dec": "1000", //decimal, Products available to user;-1 indicates no limit
"minimum_of_purchase_amount_dec": "100", //decimal, Minimum purchase amount
"maximum_of_purchase_amount_dec": "1000" //decimal, Maximum purchase amount
}
}
Parameter Name | Type | Description |
---|---|---|
product_left_quota_dec | decimal | Products remaining;-1 indicates no limit |
user_left_quota_dec | decimal | Products available to user;-1 indicates no limit |
minimum_of_purchase_amount_dec | decimal | Minimum purchase amount |
maximum_of_purchase_amount_dec | decimal | Maximum purchase amount |
Investment Trials
Interface Details: Used for product investment trials. Shows the user’s revenue for investing in a product.
GET
/smart-trend/api/v2/product/invest/trial
Request Parameters
- Request Parameter Location: query_string
Parameter Name | Type | Mandatory | Limit | Description |
---|---|---|---|---|
product_id | string | Y | 64 | Product ID: 6820591484295766016 |
coupon_ror | integer | N | - | Coupon Profit Rate e8 |
investment | integer | Y | - | Investment Amount e8 100000000 Indicates 100 unit Investment Currency |
- Response Results
- Response strings are as follows. General string text has been omitted. Please see Response Format Strings for more details:
- Data Structure & Description
curl "https://mapi.matrixport.com/smart-trend/api/v2/product/invest/trial?product_id=xxxx&investment=10000000×tamp=1627021721000&signature=d58a54d7921187bf81a0e9d028cf460f70c3c83faba7f0e9abee054e7f7bfcd1"
{
"code": 0,
"message": "",
"data": {
"estimate_min_settle_amount_dec": "301", //decimal, Estimated minimum settlement amount; Use the minimum revenue rate trial; Capital + closure period revenue collection period revenue + coupon profit e8
"estimate_max_settle_amount_dec": "301", //decimal, Estimated maximum settlement amount; Use the maximum revenue rate trial; Capital + closure period revenue collection period revenue + coupon profit e8
"estimate_settle_amount_dec": "301", //decimal, Estimated settlement amount;
"estimate_min_profit_dec": "33184931", //decimal, Estimated minimum revenue; Use the minimum revenue rate trial; Closure period revenue + collection period revenue + coupon profit e8
"estimate_max_profit_dec": "33184931", //decimal, Estimated maximum revenue; Use the maximum revenue rate trial; Closure period revenue + collection period revenue + coupon profit e8
"estimate_profit_dec": "33184931", //decimal, Estimated Profit e8
"demand_profit_dec": "3595890", //decimal, Collection Profit e8
"coupon_profit_dec": "0", //decimal, Coupon Profit e8
"estimate_min_invest_profit_dec": "29589041", //decimal, Estimated minimum closure profit e8
"estimate_max_invest_profit_dec": "29589041", //decimal, Estimated maximum closure profit e8
"currency": "USDT" //string, Currency
}
}
Parameter Name | Type | Description |
---|---|---|
estimate_min_settle_amount_dec | decimal | Estimated minimum settlement amount; Use the minimum revenue rate trial; Capital + closure period revenue collection period revenue + coupon profit e8 |
estimate_max_settle_amount_dec | decimal | Estimated maximum settlement amount; Use the maximum revenue rate trial; Capital + closure period revenue collection period revenue + coupon profit e8 |
estimate_settle_amount_dec | decimal | Estimated settlement amount; |
estimate_min_profit_dec | decimal | Estimated minimum revenue; Use the minimum revenue rate trial; Closure period revenue + collection period revenue + coupon profit e8 |
estimate_max_profit_dec | decimal | Estimated maximum revenue; Use the maximum revenue rate trial; Closure period revenue + collection period revenue + coupon profit e8 |
estimate_profit_dec | decimal | Estimated Profit e8 |
demand_profit_dec | decimal | Collection Profit e8 |
coupon_profit_dec | decimal | Coupon Profit e8 |
estimate_min_invest_profit_dec | decimal | Estimated minimum closure profit e8 |
estimate_max_invest_profit_dec | decimal | Estimated maximum closure profit e8 |
currency | string | Currency |
Make Order
Interface Description: After placing an order, you must use the Result Interface to view order information.
POST
/smart-trend/api/v2/order
Request Parameters
- Request Parameter Location: body/JSON
Parameter Name | Type | Mandatory | Limit | Description |
---|---|---|---|---|
product_id | string | Y | 64 | Product ID: 6820591484295766016 |
amount | integer | Y | - | Investment Amount |
coupon_id | integer | N | - | Coupon ID |
- Response Results
- Response strings are as follows. General string text has been omitted. Please see Response Format Strings for more details:
- Data Structure & Description
curl -H "Content-Type:application/json" -X POST --data '{"product_id":xxxx,"amount":1000000,"timestamp":1628909085000,"signature":9117bd1e5587e8318456e52e091136f1eb84ffebc1f2b9656573344962acc81a}'
https://mapi.matrixport.com/smart-trend/api/v2/order
{
"code": 0,
"message": "",
"data": {
"serial_number": "6820608333133701120", //string, Serial Number
}
}
Parameter Name | Type | Description |
---|---|---|
serial_number | string | Serial Number |
Order Result
Interface Details:
GET
/smart-trend/api/v2/order/result
Request Parameters
- Request Parameter Location: query_string
Parameter Name | Type | Mandatory | Limit | Description |
---|---|---|---|---|
serial_number | string | Y | 64 | Serial Number: 6820608333133701120 |
- Response Results
- Response strings are as follows. General string text has been omitted. Please see Response Format Strings for more details:
- Data Structure & Description
curl "https://mapi.matrixport.com/smart-trend/api/v2/order/result?serial_number=xxxx×tamp=1627021721000&signature=d58a54d7921187bf81a0e9d028cf460f70c3c83faba7f0e9abee054e7f7bfcd1"
{
"code": 0,
"message": "",
"data": {
"status": 0, //integer, Results 0 Purchasing 1 Purchased 2 Purchase failed, see failed_code and failed_message
"failed_code": 0, //integer, Failure Code
"failed_message": "" //string, Failure Message
}
}
Parameter Name | Type | Description |
---|---|---|
status | integer | Results 0 Purchasing 1 Purchased 2 Purchase failed, see failed_code and failed_message |
failed_code | integer | Failure Code |
failed_message | string | Failure Message |
Order List
Interface Details:
- Get smart-trend order list; use parameters to filter
GET
/smart-trend/api/v2/orders
Request Parameters
- Request Parameter Location: query_string
Parameter Name | Type | Mandatory | Limit | Description |
---|---|---|---|---|
currency | string | N | - | Investment Currency |
order_status | array | N | - | Order Status: 1(Pre-order), 2(Processing), 3(Canceled, Final), 4(Holding),5(Pending),6(Collecting),7(Collected, Final), 8(Refunding), 9(Refunded, Final), 10(Redeeming), 11(Redeemed All, Final) |
status_category | integer | N | - | Order status list collection: 1) All statuses, 2) Holding, 3) Settled. These values will ignore order_status when present. |
project_type | integer | N | - | Project type: 2) Limited deal 3) Revenue stage |
offset | integer | N | - | offset |
limit | integer | N | - | Limit per page |
only_need_count | string | N | - | Only obtains quantity needed. No data needs to be obtained, and the return data has only one count. |
- Response Results
- Response strings are as follows. General string text has been omitted. Please see Response Format Strings for more details:
- Data Structure & Description
curl "https://mapi.matrixport.com/smart-trend/api/v2/orders?order_status=4×tamp=1627021721000&signature=d58a54d7921187bf81a0e9d028cf460f70c3c83faba7f0e9abee054e7f7bfcd1"
{
"code": 0,
"message": "",
"data": {
"count": 1, //integer, Count of Orders
"items": [
{
"id": "6820608333133701120", //string, Order ID
"batch_no": "FixedIncome301USDT2021-07-13_18:00:007212000000", //string, Batch number
"product_id": 6820591484295766016, //integer, Product ID
"can_redeem": 0,//integer, Can you redeem early? 0: No, 1: Yes
"currency": "USDT", //string, Investment Currency
"book_time": 1626159747, //integer, Order Time
"amount_dec": 10000000000, //decimal, Investment Amount,
"start_closed_time": 1626170400, //integer, Close Start Time
"end_closed_time": 1626429600, //integer, Close End Time
"end_settled_time": 1626433200, //integer, Closing Time for Settlement
"duration": {
"close_day": 3, //integer, Close Days, Unit: Days
"value_day": 0, //integer, Close Days, Unit: Days
"value_time": 64800, //integer, Value Time: 12:00 is 12*3600
"value_limit": 0, //integer, Interest Limit;0: No limit, 1: Excludes weekends
"end_settled_day": 0, //integer, Closing Date for Settlement,T+x
"end_settled_time": 68400, //integer, Closing Time for Settlement: 12:00 is 12*3600
"settle_limit": 0 //integer, Settlement Limit;0: No limit, 1: Excludes weekends
},
"ror": 12000000, //integer, Real rate of return, e8
"redeem_ror": 0, //integer, Redeem annual interest early
"payback": 0, //integer, Actual collection, information flow or capital flow, e8
"redeem_principal": 0, //integer, Order capital returned, e8
"is_renew": 0, //integer, Activate manual renewal? 0: No 1: Yes
"is_auto_renew": 0, //integer, Activate auto renewal? 0: No 1: Yes; Priority is less than manual renewal.
"renew_type": 0, //integer, Allow users to auto-renew? 0: No 1: Yes
"is_for_new_user": false, //boolean, Is it a product for new users?
"order_status": 1, //integer, Order Status: 1(Pre-order), 2(Processing), 3(Canceled, Final), 4(Holding),5(Pending),6(Collecting),7(Collected, Final), 8(Refunding), 9(Refunded, Final), 10(Redeeming), 11(Redeemed All, Final)
"i18n": [ //array, Multilingual Product Info
{
"id": 19006, //integer, Multilingual ID
"product_id": "6820591484295766016", //string, Product ID
"language": "en", //string, Language
"name": "USDT Fixed-Term M012111", //string, Product Name
"introduction": "10086", //string, Product Info
"basic_rule": "10086" //string, Basic Rules
},
],
"redeeming_amount_dec": 0, //decimal, Redeeming Amount (amount pending approval and processing)
"estimate_settle_amount_dec": "301", //decimal, Est. Settlement Amount (trial value based on investment information, for reference only
"can_renew_product_count": 4 //integer, Renewable Product Count
}
]
}
}
Parameter Name | Type | Description |
---|---|---|
count | integer | Count of Orders |
items.id | string | Order ID |
items.batch_no | string | Batch number |
items.product_id | integer | Product ID |
items.can_redeem | integer | Can you redeem early? 0: No, 1: Yes |
items.currency | string | Investment Currency |
items.book_time | integer | Order Time |
items.amount_dec | decimal | Investment Amount |
items.start_closed_time | integer | Close Start Time |
items.end_closed_time | integer | Close End Time |
items.end_settled_time | integer | Closing Time for Settlement |
items.duration.close_day | integer | Close Days, Unit: Days |
items.duration.value_day | integer | Close Days, Unit: Days |
items.duration.value_time | integer | Value Time: 12:00 is 12*3600 |
items.duration.value_limit | integer | Interest Limit;0: No limit, 1: Excludes weekends |
items.duration.end_settled_day | integer | Closing Date for Settlement,T+x |
items.duration.end_settled_time | integer | Closing Time for Settlement: 12:00 is 12*3600 |
items.duration.settle_limit | integer | Settlement Limit;0: No limit, 1: Excludes weekends |
items.ror | integer | Real rate of return, e8 |
items.redeem_ror | integer | Redeem annual interest early |
items.payback | integer | Actual collection, information flow or capital flow, e8 |
items.redeem_principal | integer | Order capital returned, e8 |
items.is_renew | integer | Activate manual renewal? 0: No 1: Yes |
items.is_auto_renew | integer | Activate auto renewal? 0: No 1: Yes; Priority is less than manual renewal. |
items.renew_type | integer | Allow users to auto-renew? 0: No 1: Yes |
items.is_for_new_user | boolean | Is it a product for new users? |
items.order_status | integer | Order Status: 1(Pre-order), 2(Processing), 3(Canceled, Final), 4(Holding),5(Pending),6(Collecting),7(Collected, Final), 8(Refunding), 9(Refunded, Final), 10(Redeeming), 11(Redeemed All, Final) |
items.i18n | array | Multilingual Product Info |
items.i18n.id | integer | Multilingual ID |
items.i18n.product_id | string | Product ID |
items.i18n.language | string | Language |
items.i18n.name | string | Product Name |
items.i18n.introduction | string | Product Info |
items.i18n.basic_rule | string | Basic Rules |
items.redeeming_amount_dec | decimal | Redeeming Amount (amount pending approval and processing) |
items.estimate_settle_amount_dec | decimal | Est. Settlement Amount (trial value based on investment information, for reference only |
items.can_renew_product_count | integer | Renewable Product Count |
Order Details
Interface Description:
- Query detailed information a designated order.
GET
/smart-trend/api/v2/order
Request Parameters
- Request Parameter Location: query_string
Parameter Name | Type | Mandatory | Limit | Description |
---|---|---|---|---|
order_id | string | Y | 64 | Order ID: 6820608333133701120 |
- Response Results
- Response strings are as follows. General string text has been omitted. Please see Response Format Strings for more details:
- Data Structure & Description
curl "https://mapi.matrixport.com/smart-trend/api/v2/order?order_id=xxxx×tamp=1627021721000&signature=d58a54d7921187bf81a0e9d028cf460f70c3c83faba7f0e9abee054e7f7bfcd1"
{
"code": 0,
"message": "",
"data": {
"id": "6820608333133701120", //string, Order ID
"batch_no": "FixedIncome301USDT2021-07-13_18:00:007212000000", //string, Batch no
"product_id": 6820591484295766016, //integer, Product ID
"can_redeem": 0, //integer, Can you redeem early? 0: No, 1: Yes
"currency": "USDT", //string, Investment Currency
"book_time": 1626159747, //integer, Order Time
"amount_dec": 10000000000, //decimal, Investment Amount,
"start_closed_time": 1626170400, //integer, Close Start Time
"end_closed_time": 1626429600, //integer, Close End Time
"end_settled_time": 1626433200, //integer, Closing Time for Settlement
"duration": {
"close_day": 3, //integer, Close Days, Unit: Days
"value_day": 0, //integer, Close Days, Unit: Days
"value_time": 64800, //integer, Value Time: 12:00 is 12*3600
"value_limit": 0, //integer, Interest Limit;0: No limit, 1: Excludes weekends
"end_settled_day": 0, //integer, Closing Date for Settlement, T+x
"end_settled_time": 68400, //integer, Closing Time for Settlement: 12:00 is 12*3600
"settle_limit": 0 //integer, Settlement Limit;0: No limit, 1: Excludes weekends
},
"ror": 12000000, //integer, Real rate of return, e8
"redeem_ror": 0, //integer, Redeem annual interest early
"payback": 0, //integer, Actual collection, information flow or capital flow, e8
"redeem_principal": 0, //integer, Order capital returned, e8
"is_renew": 0, //integer, Activate manual renewal? 0: No 1: Yes
"is_auto_renew": 0, //integer, Activate auto renewal? 0: No 1: Yes; Priority is less than manual renewal.
"renew_type": 0, //integer, Allow users to auto-renew? 0: No 1: Yes
"is_for_new_user": false, //boolean, Is it a product for new users?
"order_status": 1, //integer, Order Status: 1(Pre-order), 2(Processing), 3(Canceled, Final), 4(Holding),5(Pending),6(Collecting),7(Collected, Final), 8(Refunding), 9(Refunded, Final), 10(Redeeming), 11(Redeemed All, Final)
"i18n": [ //array, Multilingual Product Info
{
"id": 19006, //integer, Multilingual ID
"product_id": "6820591484295766016", //string, Product ID
"language": "en", //string, Language
"name": "USDT Fixed-Term M012111", //string, Product Name
"introduction": "10086", //string, Product Info
"basic_rule": "10086" //string, Basic Rules
},
],
"redeeming_amount_dec": 0, //decimal, Redeeming Amount (amount pending approval and processing)
"estimate_settle_amount_dec": "301", //decimal, Est. Settlement Amount (trial value based on investment information, for reference onl
"can_renew_product_count": 4 //integer, Renewable Product Count
"option_portfolio":{
"options": [{ //array, options
"strike_price": 3100000000000, //integer, strike_price of option, e8 int
"underlying": "BTC", //integer, underlying of option
"strike_price_ror": 2500000, //integer, ror of option, e8 int
}, {
"strike_price": 5000000000000,
"underlying": "BTC",
"strike_price_ror": 34100000,
}],
}
}
}
Parameter Name | Type | Description |
---|---|---|
id | string | Order ID |
batch_no | string | Batch no |
product_id | integer | Product ID |
can_redeem | integer | Can you redeem early? 0: No, 1: Yes |
currency | string | Investment Currency |
book_time | integer | Order Time |
amount_dec | decimal | Investment Amount |
start_closed_time | integer | Close Start Time |
end_closed_time | integer | Close End Time |
end_settled_time | integer | Closing Time for Settlement |
duration.close_day | integer | Close Days, Unit: Days |
duration.value_day | integer | Close Days, Unit: Days |
duration.value_time | integer | Value Time: 12:00 is 12*3600 |
duration.value_limit | integer | Interest Limit;0: No limit, 1: Excludes weekends |
duration.end_settled_day | integer | Closing Date for Settlement, T+x |
duration.end_settled_time | integer | Closing Time for Settlement: 12:00 is 12*3600 |
duration.settle_limit | integer | Settlement Limit;0: No limit, 1: Excludes weekends |
ror | integer | Real rate of return, e8 |
redeem_ror | integer | Redeem annual interest early |
payback | integer | Actual collection, information flow or capital flow, e8 |
redeem_principal | integer | Order capital returned, e8 |
is_renew | integer | Activate manual renewal? 0: No 1: Yes |
is_auto_renew | integer | Activate auto renewal? 0: No 1: Yes; Priority is less than manual renewal. |
renew_type | integer | Allow users to auto-renew? 0: No 1: Yes |
is_for_new_user | boolean | Is it a product for new users? |
order_status | integer | Order Status: 1(Pre-order), 2(Processing), 3(Canceled, Final), 4(Holding),5(Pending),6(Collecting),7(Collected, Final), 8(Refunding), 9(Refunded, Final), 10(Redeeming), 11(Redeemed All, Final) |
i18n | array | Multilingual Product Info |
i18n.id | integer | Multilingual ID |
i18n.product_id | string | Product ID |
i18n.language | string | Language |
i18n.name | string | Product Name |
i18n.introduction | string | Product Info |
i18n.basic_rule | string | Basic Rules |
redeeming_amount_dec | decimal | Redeeming Amount (amount pending approval and processing) |
estimate_settle_amount_dec | decimal | Est. Settlement Amount (trial value based on investment information, for reference onl |
can_renew_product_count | integer | Renewable Product Count |
option_portfolio.options | array | options |
option_portfolio.options.strike_price | integer | strike_price of option, e8 int |
option_portfolio.options.underlying | integer | underlying of option |
option_portfolio.options.strike_price_ror | integer | ror of option, e8 int |
Manual Renewal Products
Interface Details:
- Query manual renewal products for an order if the order is set to manual-renewal.
GET
/smart-trend/api/v2/order/manual_renew/products
Request Parameters
- Request Parameter Location: query_string
Parameter Name | Type | Mandatory | Limit | Description |
---|---|---|---|---|
order_id | string | Y | 64 | Order ID: 6820608333133701120 |
- Response Results
- Response strings are as follows. General string text has been omitted. Please see Response Format Strings for more details:
- Data Structure & Description
curl "https://mapi.matrixport.com/smart-trend/api/v2/order/manual_renew/products?order_id=xxxx×tamp=1627021721000&signature=d58a54d7921187bf81a0e9d028cf460f70c3c83faba7f0e9abee054e7f7bfcd1"
{
"code": 0,
"message": "",
"data": {
"count": 1, //integer, Count
"items": [ //array
{
"id": "6812413916300247040", //string, Product ID
"renew_type": 0, //integer, Can you auto-renew?; 0: No 1: Yes
"currency": "USDT", //string, Investment Currency
"minimum_of_purchase_amount_dec": "0", //decimal, Minimum single transaction amount; initial investment amount,
"maximum_of_purchase_amount_dec": "0", //decimal, Maximum single transaction amount,
"user_purchase_limit_dec": "1000", //decimal, Maximum single user purchase amount,
"can_redeem": 1, //integer, Can you redeem early?; 0: No 1: Yes
"redeem_ror": 9000000, //integer, Redeem Interest
"ror": 12000000, //integer, Annual interest, e8 12% annual interest
"status": 2, //integer, Product status: 1: Pending 2: Available 3: Sold out 4: Outdated(can not buy)
"agreements": null, //array, Product protocol; See Product Interface details on structure definition; List Interface does not return this data string
"tags": [
{
"id": 5000, //integer, Label ID
"deleted_at": null, //integer, Deletion Time
"product_id": "6816308388557815808", //string, Product ID
"language": "zh-CN", //string, Product Language
"tag": "High interest" //string, Label Content
},
],
"i18n": [
{
"id": 2450, //integer, Multilingual ID
"product_id": "6812413916300247040", //string, Product ID
"language": "zh-CN", //string, Language
"name": " Actively renew smart-trend products USDT 2021-06-21 00:20:46", //string, Product Name
"introduction": "123", //string, Product Info
"basic_rule": "" //string, Basic Rules
}
],
"duration": {
"close_day": 4, //integer, Close Days, Unit: Days
"value_day": 0, //integer, Value Date: T+x, Unit: Days
"value_time": 0, //integer, Value Time: 12:00 is 12*3600
"value_limit": 0, //integer, Interest Limit;0: No limit, 1: Excludes weekends
"end_settled_day": 1, //integer, Closing Date for Settlement, T+x
"end_settled_time": 43200, //integer, Closing Time for Settlement: 12:00 is 12*3600
"settle_limit": 0 //integer, Settlement Limit;0: No limit, 1: Excludes weekends
},
"is_for_new_user": false, //boolean, Is it a product for new users?
"raised_time": 1626451200, //integer, Raise End Time
"start_closed_time": 1626451200, //integer, Close Start Time
"end_closed_time": 1626796800, //integer, Close End Time
"end_settled_time": 1626926400 //integer, Closing Time for Settlement
}
]
}
}
Parameter Name | Type | Description |
---|---|---|
count | integer | Count |
items | None | array |
items.id | string | Product ID |
items.renew_type | integer | Can you auto-renew?; 0: No 1: Yes |
items.currency | string | Investment Currency |
items.minimum_of_purchase_amount_dec | decimal | Minimum single transaction amount; initial investment amount |
items.maximum_of_purchase_amount_dec | decimal | Maximum single transaction amount |
items.user_purchase_limit_dec | decimal | Maximum single user purchase amount |
items.can_redeem | integer | Can you redeem early?; 0: No 1: Yes |
items.redeem_ror | integer | Redeem Interest |
items.ror | integer | Annual interest, e8 12% annual interest |
items.status | integer | Product status: 1: Pending 2: Available 3: Sold out 4: Outdated(can not buy) |
items.agreements | array | Product protocol; See Product Interface details on structure definition; List Interface does not return this data string |
items.tags.id | integer | Label ID |
items.tags.deleted_at | integer | Deletion Time |
items.tags.product_id | string | Product ID |
items.tags.language | string | Product Language |
items.tags.tag | string | Label Content |
items.i18n.id | integer | Multilingual ID |
items.i18n.product_id | string | Product ID |
items.i18n.language | string | Language |
items.i18n.name | string | Product Name |
items.i18n.introduction | string | Product Info |
items.i18n.basic_rule | string | Basic Rules |
items.duration.close_day | integer | Close Days, Unit: Days |
items.duration.value_day | integer | Value Date: T+x, Unit: Days |
items.duration.value_time | integer | Value Time: 12:00 is 12*3600 |
items.duration.value_limit | integer | Interest Limit;0: No limit, 1: Excludes weekends |
items.duration.end_settled_day | integer | Closing Date for Settlement, T+x |
items.duration.end_settled_time | integer | Closing Time for Settlement: 12:00 is 12*3600 |
items.duration.settle_limit | integer | Settlement Limit;0: No limit, 1: Excludes weekends |
items.is_for_new_user | boolean | Is it a product for new users? |
items.raised_time | integer | Raise End Time |
items.start_closed_time | integer | Close Start Time |
items.end_closed_time | integer | Close End Time |
items.end_settled_time | integer | Closing Time for Settlement |
Renew an Order
Interface Details: Users can manually add a renewal product to an order to pre-order a new order, if the order is set to manual-renewal.
POST
/smart-trend/api/v2/order/renew
Request Parameters
- Request Parameter Location: body/json
Parameter Name | Type | Mandatory | Limit | Description |
---|---|---|---|---|
order_id | string | Y | 64 | Order ID: 6820626049743773696 |
product_id | string | Y | 64 | Product ID: 6820608333133701120 |
coupon_id | integer | N | - | Coupon ID: |
- Response Results
- Response strings are as follows. General string text has been omitted. Please see Response Format Strings for more details:
- Data Structure & Description
curl -H "Content-Type:application/json" -X POST --data '{"product_id":xxxx,"order_id":yyyyyy,"timestamp":1628909085000,"signature":9117bd1e5587e8318456e52e091136f1eb84ffebc1f2b9656573344962acc81a}'
https://mapi.matrixport.com/smart-trend/api/v2/order/renew
{
"code": 0,
"message": "",
"data": {
"id": 1238, //integer, Investment Renewal ID
"created_on": 1626173407,
"modified_on": 1626173407,
"fixed_order_id": 6820626049743773696, //integer, Order ID and request parameters are the same.
"product_id": 6812413916300247040, //integer, Investment Renewal Product ID
"next_order_id": 0, //integer, Only available after successfully investing a new Order ID.
"fail_reason": 0, //integer, Reason for failed renewal: 1. Product is no longer on sale. 2. Product is not collecting.
"status": 1 //integer, Renewal Status: 1. Applying 2. Canceled 3. Renewing 4. Renewed 5. Failed
}
}
Parameter Name | Type | Description |
---|---|---|
id | integer | Investment Renewal ID |
fixed_order_id | integer | Order ID and request parameters are the same. |
product_id | integer | Investment Renewal Product ID |
next_order_id | integer | Only available after successfully investing a new Order ID. |
fail_reason | integer | Reason for failed renewal: 1. Product is no longer on sale. 2. Product is not collecting. |
status | integer | Renewal Status: 1. Applying 2. Canceled 3. Renewing 4. Renewed 5. Failed |
Detail of Renewal Order
Interface Details:
- Query renewal order details.
GET
/smart-trend/api/v2/order/renew/detail
Request Parameters
- Request Parameter Location: query_string
Parameter Name | Type | Mandatory | Limit | Description |
---|---|---|---|---|
order_id | string | Y | 64 | Order ID: 6820608333133701120 |
- Response Results
- Response strings are as follows. General string text has been omitted. Please see Response Format Strings for more details:
- Data Structure & Description
curl "https://mapi.matrixport.com/smart-trend/api/v2/order/renew/detail?order_id=xxxx×tamp=1627021721000&signature=d58a54d7921187bf81a0e9d028cf460f70c3c83faba7f0e9abee054e7f7bfcd1"
{
"code": 0,
"message": "",
"data": {
"id": 1238, //integer, Redeem ID, auto-increment
"fixed_order_id": 6820626049743773696, //integer, Old Order ID
"product_id": 6812413916300247040, //integer, Investment Renewal Product ID
"next_order_id": 0, //integer, New Order ID
"fail_reason": 0, //integer, Reason for failed renewal: 1. Product is no longer on sale. 2. Product is not collecting.
"status": 1, //integer, Renewal Status: 1. Applying 2. Canceled 3. Renewing 4. Renewed 5. Failed
"product": {
"id": "6812413916300247040", //string, Product ID
"renew_type": 0, //integer, Can you auto-renew?; 0: No 1: Yes
"currency": "USDT", //string, Investment Currency
"minimum_of_purchase_amount_dec": "0", //decimal, Minimum single transaction amount; initial investment amount,
"maximum_of_purchase_amount_dec": "0", //decimal, Maximum single transaction amount,
"user_purchase_limit_dec": "1000", //decimal, Maximum single user purchase amount,
"can_redeem": 1, //integer, Can you redeem early?;0: No 1: Yes
"redeem_ror": 9000000, //integer, Redeem Interest
"ror": 12000000, //integer, Annual interest, e8 12% annual interest
"status": 2, //integer, Product status: 1: Pending 2: Available 3: Sold out 4: Outdated(can not buy)
"i18n": [
{
"id": 2450, //integer, Multilingual ID
"product_id": "6812413916300247040", //string, Product ID
"language": "zh-CN", //string, Language
"name": "Actively renew smart-trend products CN USDT 2021-06-21 00:20:46", //string, Product Name
"introduction": "123", //string, Product Info
"basic_rule": "" //string, Basic Rules
}
],
"duration": {
"close_day": 4, //integer, Close Days, Unit: Days
"value_day": 0, //integer, Value Date: T+x, Unit: Days
"value_time": 0, //integer, Value Time: 12:00 is 12*3600
"value_limit": 0, //integer, Interest Limit;0: No limit, 1: Excludes weekends
"end_settled_day": 1, //integer, Closing Date for Settlement, T+x
"end_settled_time": 43200, //integer, Closing Time for Settlement: 12:00 is 12*3600
"settle_limit": 0 //integer, Settlement Limit;0: No limit, 1: Excludes weekends
},
"fund_investments": null,
"is_for_new_user": false, //bool, Is it a product for new users?
"raised_time": 1626451200, //integer, Raise End Time
"start_closed_time": 1626451200, //integer, Close Start Time
"end_closed_time": 1626796800, //integer, Close End Time
"end_settled_time": 1626926400 //integer, Closing Time for Settlement
},
"coupon": { // object, Coupon
"id": 6666, //integer, Coupon ID
"year_rate": 8000000 //integer, Coupon Annual Revenue
}
}
}
Parameter Name | Type | Description |
---|---|---|
id | integer | Redeem ID, auto-increment |
fixed_order_id | integer | Old Order ID |
product_id | integer | Investment Renewal Product ID |
next_order_id | integer | New Order ID |
fail_reason | integer | Reason for failed renewal: 1. Product is no longer on sale. 2. Product is not collecting. |
status | integer | Renewal Status: 1. Applying 2. Canceled 3. Renewing 4. Renewed 5. Failed |
product.id | string | Product ID |
product.renew_type | integer | Can you auto-renew?; 0: No 1: Yes |
product.currency | string | Investment Currency |
product.minimum_of_purchase_amount_dec | decimal | Minimum single transaction amount; initial investment amount |
product.maximum_of_purchase_amount_dec | decimal | Maximum single transaction amount |
product.user_purchase_limit_dec | decimal | Maximum single user purchase amount |
product.can_redeem | integer | Can you redeem early?;0: No 1: Yes |
product.redeem_ror | integer | Redeem Interest |
product.ror | integer | Annual interest, e8 12% annual interest |
product.status | integer | Product status: 1: Pending 2: Available 3: Sold out 4: Outdated(can not buy) |
product.i18n.id | integer | Multilingual ID |
product.i18n.product_id | string | Product ID |
product.i18n.language | string | Language |
product.i18n.name | string | Product Name |
product.i18n.introduction | string | Product Info |
product.i18n.basic_rule | string | Basic Rules |
product.duration.close_day | integer | Close Days, Unit: Days |
product.duration.value_day | integer | Value Date: T+x, Unit: Days |
product.duration.value_time | integer | Value Time: 12:00 is 12*3600 |
product.duration.value_limit | integer | Interest Limit;0: No limit, 1: Excludes weekends |
product.duration.end_settled_day | integer | Closing Date for Settlement, T+x |
product.duration.end_settled_time | integer | Closing Time for Settlement: 12:00 is 12*3600 |
product.duration.settle_limit | integer | Settlement Limit;0: No limit, 1: Excludes weekends |
product.is_for_new_user | bool | Is it a product for new users? |
product.raised_time | integer | Raise End Time |
product.start_closed_time | integer | Close Start Time |
product.end_closed_time | integer | Close End Time |
product.end_settled_time | integer | Closing Time for Settlement |
coupon | None | Coupon |
coupon.id | integer | Coupon ID |
coupon.year_rate | integer | Coupon Annual Revenue |
Turn Off Auto-renewal of an Order
Interface Details: Users can turn off auto-renewal of an order if the order is set to auto-renewal.
POST
/smart-trend/api/v2/order/auto_renew/switch/off
Request Parameters
- Request Parameter Location: body/json
Parameter Name | Type | Mandatory | Limit | Description |
---|---|---|---|---|
order_id | string | Y | 64 | Order ID: 6820626049743773696 |
- Response Results
- Response strings are as follows. General string text has been omitted. Please see Response Format Strings for more details:
- Data Structure & Description
curl -H "Content-Type:application/json" -X POST --data '{"order_id":yyyyyy,"timestamp":1628909085000,"signature":9117bd1e5587e8318456e52e091136f1eb84ffebc1f2b9656573344962acc81a}'
https://mapi.matrixport.com/smart-trend/api/v2/order/auto_renew/switch/off
{
"code": 0,
"message": "",
"data": null
}
Turn On Auto-renewal of an Order
Interface Details: Users can turn on auto-renewal of an order if the order is set to auto-renewal.
POST
/smart-trend/api/v2/order/auto_renew/switch/on
Request Parameters
- Request Parameter Location: body/json
Parameter Name | Type | Mandatory | Limit | Description |
---|---|---|---|---|
order_id | string | Y | 64 | Order ID: 6820626049743773696 |
- Response Results
- Response strings are as follows. General string text has been omitted. Please see Response Format Strings for more details:
- Data Structure & Description
curl -H "Content-Type:application/json" -X POST --data '{"order_id":yyyyyy,"timestamp":1628909085000,"signature":9117bd1e5587e8318456e52e091136f1eb84ffebc1f2b9656573344962acc81a}'
https://mapi.matrixport.com/smart-trend/api/v2/order/auto_renew/switch/on
{
"code": 0,
"message": "",
"data": null
}
Auto Renewal Products
Interface Details:
- Query auto renewal products for an order if the order is set to auto-renewal.
GET
/smart-trend/api/v2/order/auto_renew/products
Request Parameters
- Request Parameter Location: query_string
Parameter Name | Type | Mandatory | Limit | Description |
---|---|---|---|---|
order_id | string | Y | 64 | Order ID: 6820608333133701120 |
- Response Results
- Response strings are as follows. General string text has been omitted. Please see Response Format Strings for more details:
- Data Structure & Description
curl "https://mapi.matrixport.com/smart-trend/api/v2/order/auto_renew/products?order_id=xxxx×tamp=1627021721000&signature=d58a54d7921187bf81a0e9d028cf460f70c3c83faba7f0e9abee054e7f7bfcd1"
{
"code": 0,
"message": "",
"data": {
"count": 1, //integer, Count
"items": [ //array
{
"id": "6812413916300247040", //string, Product ID
"renew_type": 0, //integer, Can you auto-renew?; 0: No 1: Yes
"currency": "USDT", //string, Investment Currency
"minimum_of_purchase_amount_dec": "0", //decimal, Minimum single transaction amount; initial investment amount,
"maximum_of_purchase_amount_dec": "0", //decimal, Maximum single transaction amount,
"user_purchase_limit_dec": "1000", //decimal, Maximum single user purchase amount,
"can_redeem": 1, //integer, Can you redeem early?; 0: No 1: Yes
"redeem_ror": 9000000, //integer, Redeem Interest
"ror": 12000000, //integer, Annual interest, e8 12% annual interest
"status": 2, //integer, Product status: 1: Pending 2: Available 3: Sold out 4: Outdated(can not buy)
"agreements": null, //array, Product protocol; See Product Interface details on structure definition; List Interface does not return this data string
"tags": [
{
"id": 5000, //integer, Label ID
"deleted_at": null, //integer, Deletion Time
"product_id": "6816308388557815808", //string, Product ID
"language": "zh-CN", //string, Product Language
"tag": "High interest" //string, Label Content
},
],
"i18n": [
{
"id": 2450, //integer, Multilingual ID
"product_id": "6812413916300247040", //string, Product ID
"language": "zh-CN", //string, Language
"name": " Actively renew smart-trend products USDT 2021-06-21 00:20:46", //string, Product Name
"introduction": "123", //string, Product Info
"basic_rule": "" //string, Basic Rules
}
],
"duration": {
"close_day": 4, //integer, Close Days, Unit: Days
"value_day": 0, //integer, Value Date: T+x, Unit: Days
"value_time": 0, //integer, Value Time: 12:00 is 12*3600
"value_limit": 0, //integer, Interest Limit;0: No limit, 1: Excludes weekends
"end_settled_day": 1, //integer, Closing Date for Settlement, T+x
"end_settled_time": 43200, //integer, Closing Time for Settlement: 12:00 is 12*3600
"settle_limit": 0 //integer, Settlement Limit;0: No limit, 1: Excludes weekends
},
"is_for_new_user": false, //boolean, Is it a product for new users?
"raised_time": 1626451200, //integer, Raise End Time
"start_closed_time": 1626451200, //integer, Close Start Time
"end_closed_time": 1626796800, //integer, Close End Time
"end_settled_time": 1626926400 //integer, Closing Time for Settlement
}
]
}
}
Parameter Name | Type | Description |
---|---|---|
count | integer | Count |
items | None | array |
items.id | string | Product ID |
items.renew_type | integer | Can you auto-renew?; 0: No 1: Yes |
items.currency | string | Investment Currency |
items.minimum_of_purchase_amount_dec | decimal | Minimum single transaction amount; initial investment amount |
items.maximum_of_purchase_amount_dec | decimal | Maximum single transaction amount |
items.user_purchase_limit_dec | decimal | Maximum single user purchase amount |
items.can_redeem | integer | Can you redeem early?; 0: No 1: Yes |
items.redeem_ror | integer | Redeem Interest |
items.ror | integer | Annual interest, e8 12% annual interest |
items.status | integer | Product status: 1: Pending 2: Available 3: Sold out 4: Outdated(can not buy) |
items.agreements | array | Product protocol; See Product Interface details on structure definition; List Interface does not return this data string |
items.tags.id | integer | Label ID |
items.tags.deleted_at | integer | Deletion Time |
items.tags.product_id | string | Product ID |
items.tags.language | string | Product Language |
items.tags.tag | string | Label Content |
items.i18n.id | integer | Multilingual ID |
items.i18n.product_id | string | Product ID |
items.i18n.language | string | Language |
items.i18n.name | string | Product Name |
items.i18n.introduction | string | Product Info |
items.i18n.basic_rule | string | Basic Rules |
items.duration.close_day | integer | Close Days, Unit: Days |
items.duration.value_day | integer | Value Date: T+x, Unit: Days |
items.duration.value_time | integer | Value Time: 12:00 is 12*3600 |
items.duration.value_limit | integer | Interest Limit;0: No limit, 1: Excludes weekends |
items.duration.end_settled_day | integer | Closing Date for Settlement, T+x |
items.duration.end_settled_time | integer | Closing Time for Settlement: 12:00 is 12*3600 |
items.duration.settle_limit | integer | Settlement Limit;0: No limit, 1: Excludes weekends |
items.is_for_new_user | boolean | Is it a product for new users? |
items.raised_time | integer | Raise End Time |
items.start_closed_time | integer | Close Start Time |
items.end_closed_time | integer | Close End Time |
items.end_settled_time | integer | Closing Time for Settlement |
Coupon List
Interface Details:
- When using a coupon to purchase a product, use this interface to call available product coupons. Coupons have restrictions regarding min/max value, order type, etc.
GET /smart-trend/api/v2/order/coupons
Request Parameters
- Request Parameter Location: query_string
Parameter Name | Type | Mandatory | Limit | Description |
---|---|---|---|---|
order_id | string | Y | - | Product ID: 6820617394550005760 |
amount | integer | N | - | Investment Amount |
order_type | integer | N | - | Order Type, 0: New Order,1: Renewal Order |
- Response Results
- Response strings are as follows. General string text has been omitted. Please see Response Format Strings for more details:
- Data Structure & Description
curl "https://mapi.matrixport.com/smart-trend/api/v2/order/coupons?order_id=xxxx×tamp=1627021721000&signature=d58a54d7921187bf81a0e9d028cf460f70c3c83faba7f0e9abee054e7f7bfcd1"
{
"code": 0,
"message": "",
"data": {
"coupons": [
{
"id": "6820967743295119360", //string, Coupon ID
"available": true, //boolean, Is it available?
"expiration_time": 1657781438489, //integer,Expiration Time Milliseconds
"year_rate": 16000000, //integer, Coupon Rate e8
"min_amount_dec": "100000000", //decimal, Min available
"max_amount_dec": "1000000000000", //decimal, Max available
"template_names": [ //array, Template Name
{
"item": "TemplateName",
"language": "En-US", //string, Language
"data": "10086", //string, Event Name
"trigger": ""//string,
},
]
}
]
}
}
Parameter Name | Type | Description |
---|---|---|
coupons.id | string | Coupon ID |
coupons.available | boolean | Is it available? |
coupons.expiration_time | integer | Expiration Time Milliseconds |
coupons.year_rate | integer | Coupon Rate e8 |
coupons.min_amount_dec | decimal | Min available |
coupons.max_amount_dec | decimal | Max available |
coupons.template_names | array | Template Name |
coupons.template_names.language | string | Language |
coupons.template_names.data | string | Event Name |
Error Codes
- Response return calls indicate the call and execution result summary for current API services. Return code messages provide additional information for the user to determine API execution.
- All interface call return values contain an error code (value) and message (error description). See below:
Return Codes | Details |
---|---|
0 | OK. |
17002001 | Parameter error. |
17002012 | Invalid interface authorization. |
17002011 | Restricted IP. |
17002010 | Signature error. |
17002013 | Invalid akid. |
1203001 | Internal error. |
1203002 | Failed to cancel. |
1203003 | Product is not undergoing collection. |
1203004 | Product is still undergoing collection. |
1203005 | Login required. |
1203006 | Cannot generate pending settlement status. Current order is not processing. |
1203007 | Insufficient value remaining. |
1203008 | Request frequency too high. |
1203009 | Insufficient product(s). |
12030010 | Exceeds purchase limit. |
12030011 | Minimum purchase amount not met. |
12030012 | Cannot purchase at this time. |
12030013 | Cannot auto-renew normal products. |
12030014 | Cannot auto-renew this product, or this product is not available for purchase. |
12030015 | Cannot purchase auto-renew products. |
12030016 | Cannot make duplicate auto-renew requests. |
12030017 | Cannot send auto-renew request. Order is not pending. |
12030018 | Cannot send auto-renew request. Closing end time for the order must be earlier than the closing start time for auto-renew productions. |
12030019 | Cannot send auto-renew request. You must use the same currency as the order. |
12030020 | Order is not pending. |
12030021 | Product is not redeemable. |
12030022 | You may only view your own orders. |
12030023 | Exceeds individual purchase limit. |
12030024 | Cannot update auto-renew status. Order must be processing, holding, pending calculation, or on preorder to perform this operation. |
12030025 | This product does not support auto-renewal. |
12030030 | Unable to change auto-renewal product limit at this time. |
12030031 | Cannot redeem. Redeem value exceeds the total order cost. |
12030033 | Invalid coupon. |
12030034 | Current batch is no longer undergoing collection. Please wait for the next batch. |
12030035 | Redeeming current order. |
12030036 | No auto-renew products found. |
12030037 | Unable to auto-renew order at this time. |