Changelogs

version	time	content
V1.0.0	2022-10-14	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/fixed-income/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

please refer to this link

Fixed-Staking API

Products List

Interface Description
- view the fixed-staking products
GET /eth-two/api/v2/products
Request Parameters
- Request Parameter Location: query_string
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/eth-two/api/v2/products?timestamp=1627021721000&signature=d58a54d7921187bf81a0e9d028cf460f70c3c83faba7f0e9abee054e7f7bfcd1"

{
    "code": 0,
    "data": {
        "count": 2, // integer, query amount; Return amount is set according to the offset and limit
        "items": [
            //array,items  
            {
                "id": "6984793150468501504", //string, Product id
                "sale_start_at": 1665304609, //integer, Product when start to sale
                "currency": "ETH", //string, Investment currency
                "share_price": 0, //integer, the product latest share price
                "subject_type": "ETH2.0", //string, the product subject  
                "main_product_type": 40, //integer, ETH staking main product
                "raised_amount_dec": "3000", //decimal, Total raised amount
                "minimum_of_purchase_amount_dec": "1", //decimal, Minimum single transaction amount;
                "maximum_of_purchase_amount_dec": "0", //decimal, Maximum single transaction amount,0 is not limit
                "user_purchase_limit_dec": "0", //decimal, Maximum single user purchase amount
                "current_raise_amount_dec": "0", //decimal, The product current raised amount
                "can_redeem": 2, // integer, Can you redeem early?；0: No 1: Yes 2.redeem windows
                "minimum_of_ror": 0, //integer, Estimate Minimum of interest, e8, 3%  annual interest
                "maximum_of_ror": 0, //integer, Estimate Maximum of 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, ID
                    "deleted_at": null, //integer,Deletion Time
                    "product_id": "6984793150468501504", //string, Product ID
                    "language": "zh-CN", //string, Product Language
                    "tag": "can redeem", //string, Label Content
                  },
                ],
                "i18n": [
                  //array, Multilingual Product Info
                  {
                    "id": 19004, //integer, Multilingual ID
                    "product_id": "6984793150468501504", //string, Product ID
                    "language": "zh-CN", //string, Language
                    "name": "Eth2.0 staking", //string, Product name
                    "introduction": "Eth2.0 staking", //string, Product Info
                    "basic_rule":
                      "Minimum purchase amount is set to 0.1 ETH；Cannot redeem early ", //string, Basic Rules
                  },
                ],
                "duration": {
                    "close_day": 0, //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": 0, //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, //array, Funds destination; Product list does not return this data string. View the Product Info Interface for structural information.
                "redeem_windows": null, //object, redeem windows, Product list does not return this data string. View the Product Info Interface for structural information.
                "explain": null, //array, explain; Product list does not return this data string. View the Product Info Interface for structural information.
                "raised_time": 1729699200, // integer,raised end time 
                "start_closed_time": 1666713600, // integer,order start closed time
                "end_closed_time": 0, // integer,order end closed time
                "end_settled_time": 0, // integer,order end settled time
                "last_rate_ror": 8000000  // integer,last share prices's ror,e8
            },
            {
                "id": "6984808120929382400",
                "sale_start_at": 1665331200,
                "raised_amount": 3000000000000000,
                "current_raise_amount": 500000000000,
                "renew_type": 0,
                "currency": "ETH",
                "share_price": 0,
                "subject_type": "ETH2.0 leverage staking",
                "main_product_type": 40,
                "minimum_of_purchase_amount": 100000000,
                "maximum_of_purchase_amount": 0,
                "user_purchase_limit": 0,
                "raised_amount_dec": "30000000",
                "minimum_of_purchase_amount_dec": "1",
                "maximum_of_purchase_amount_dec": "0",
                "user_purchase_limit_dec": "0",
                "current_raise_amount_dec": "5000",
                "can_redeem": 2,
                "redeem_ror": 0,
                "minimum_of_redeem_fee_ror": 0,
                "performance_fee": 0,
                "minimum_of_ror": 0,
                "maximum_of_ror": 0,
                "status": 2,
                "agreements": null,
                "tags": [],
                "i18n": [
                    {
                        "id": 75044,
                        "product_id": "6984808120929382400",
                        "language": "en",
                        "name": "ETHstaking-test",
                        "introduction": "",
                        "basic_rule": ""
                    }
                ],
                "duration": {
                    "close_day": 0,
                    "value_day": 0,
                    "value_time": 0,
                    "value_limit": 0,
                    "end_settled_day": 0,
                    "end_settled_time": 43200,
                    "settle_limit": 0
                },
                "fund_investments": null,
                "explain": null,
                "raised_time": 1728576000,
                "start_closed_time": 1665079200,
                "end_closed_time": 0,
                "end_settled_time": 0,
                "last_rate_ror": 4000000
            }
        ]
    },
    "message": ""
}

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.sale_start_at	integer	Product when start to sale
items.currency	string	Investment currency
items.share_price	integer	the product latest share price
items.main_product_type	integer
items.raised_amount_dec	decimal	Total raised amount
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.current_raise_amount_dec	decimal	The product current raised amount
items.can_redeem	integer	integer, Can you redeem early?；0: No 1: Yes 2.redeem windows
items.minimum_of_ror	integer	Estimate Minimum of interest, e8, 3% annual interest
items.maximum_of_ror	integer	Estimate Maximum of interest, e8, 3% 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.explain	array	Product list does not return this data string. View the Product Info Interface for structural information.
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
items.last_rate_ror	integer	Last Share prices's ror,e8

Product Detail

Interface Details:
- display information for a single fixed-staking product.
GET /eth-two/api/v2/product
Request Parameters
- Request Parameter Location: query_string

Parameter Name	Type	Mandatory	Limit	Description
product_id	string	Y	64	Product ID: 6984793150468501504

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/eth-two/api/v2/product?product_id=6984793150468501504&timestamp=1627021721000&signature=d58a54d7921187bf81a0e9d028cf460f70c3c83faba7f0e9abee054e7f7bfcd1"

{
  "code": 0,
  "data": {
      "id": "6984793150468501504", // string, Product id
      "sale_start_at": 1665304609, //integer, Product when start to sale
      "currency": "ETH", //string, Investment currency
      "share_price": 0, //integer, the product latest share price
      "subject_type": "ETH2.0", //string, the product subject  
      "main_product_type": 40, //integer, ETH staking main product
      "raised_amount_dec": "3000", //decimal, Total raised amount
      "minimum_of_purchase_amount_dec": "1", //decimal, Minimum single transaction amount;
      "maximum_of_purchase_amount_dec": "0", //decimal, Maximum single transaction amount,0 is not limit
      "user_purchase_limit_dec": "0", //decimal, Maximum single user purchase amount
      "current_raise_amount_dec": "0", //decimal, The product current raised amount
      "can_redeem": 2, // integer, Can you redeem early?；0: No 1: Yes 2.redeem windows
      "minimum_of_ror": 0, //integer, Estimate Minimum of interest, e8, 3%  annual interest
      "maximum_of_ror": 0, //integer, Estimate Maximum of interest, e8, 12% annual interest
      "status": 2, //integer, Product status: 1: Pending 2: Available 3: Sold out 4: Outdated(can not buy)
      "agreements": [
      {
        "id": 28366,
        "product_id": "6984793150468501504",
        "agreement": "ETH2.0agreement"
      }
    ],
      "tags": [
      //array, Product Label (Displays behind product name to entice users to purchase,. For example, "Redeem Early", "Star Product"）
      {
        "id": 5216, //integer, ID
        "deleted_at": null, //integer,Deletion Time
        "product_id": "6984793150468501504", //string, Product ID
        "language": "zh-CN", //string, Product Language
        "tag": "can redeem", //string, Label Content
      },
    ],
      "i18n": [
      //array, Multilingual Product Info
      {
        "id": 75028, //integer, Multilingual ID
        "product_id": "6984793150468501504", //string, Product ID
        "language": "en", //string, Language
        "name": "ETH2.0 test", //string, Product name
        "introduction": "Eth2.0 staking", //string, Product Info
        "basic_rule": "Minimum purchase amount is set to 0.1 ETH；Cannot redeem early ", //string, Basic Rules
      }
    ],
      "duration": {
      "close_day": 0, //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": 0, //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": [
      {
        "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
      }
    ],
      "explain": [
      {
        "id": 170144, //integer, Explain ID
        "product_id": "6820591484295766016", //string, Product ID
        "language": "en", //string, Language
        "title": "Revenue Model", // string,title
        "introduction": "introduction Info (EN)" //  string,introduction
      }
    ],
      "raised_time": 1729699200, // integer,raised end time 
      "start_closed_time": 1666713600, // integer,order start closed time
      "end_closed_time": 0, // integer,order end closed time
      "end_settled_time": 0, // integer,order end settled time
      "last_rate_ror": 0 // integer,last share prices's ror,e8
  },
  "message": ""
}

Parameter Name	Type	Description
id	string	Product id
sale_start_at	integer	Product when start to sale
currency	string	Investment currency
share_price	integer	the product latest share price
main_product_type	integer
raised_amount_dec	decimal	Total raised amount
minimum_of_purchase_amount_dec	decimal	Minimum single transaction amount;
maximum_of_purchase_amount_dec	decimal	Maximum single transaction amount
user_purchase_limit_dec	decimal	Maximum single user purchase amount
current_raise_amount_dec	decimal	The product current raised amount
can_redeem	integer	integer, Can you redeem early?；0: No 1: Yes 2.redeem windows
minimum_of_ror	integer	Estimate Minimum of interest, e8, 3% annual interest
maximum_of_ror	integer	Estimate Maximum of interest, e8, 3% annual interest
status	integer	Product status: 1: Pending 2: Available 3: Sold out 4: Outdated(can not buy)
agreements	array	Multilingual Product agreements
agreements.id	integer	agreement id
agreements.product_id	string	Product id
agreements.agreement	string	agreement name
tags	array	Product Label (Displays behind product name to entice users to purchase,. For example, "Redeem Early", "Star Product"）
tags.id	integer	Label ID
tags.deleted_at	integer	Deletion Time
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	Value Date: T+x, 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	array	Funds destination; Product list does not return this data string. View the Product Info Interface for structural information.
fund_investments.id	integer	agreement id
fund_investments.language	integer	language
fund_investments.product_id	string	Product id
fund_investments.fund_investment	string	Fund_investment
explain	array	Product list does not return this data string. View the Product Info Interface for structural information.
explain.id	integer	explain id
explain.language	integer	language
explain.product_id	string	Product id
explain.introduction	string	introduction
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
last_rate_ror	integer	Last share prices's ror,e8

Remaining Quota

Interface Details:
- return the quota for fixed-staking product.
GET /eth-two/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/eth-two/api/v2/product/quota?product_id=6820591484295766016&timestamp=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

Make Order

Interface Description: After placing an order, you must use the Result Interface to view order information.
POST /eth-two/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_dec	decimal	Y	-	Investment Amount

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":6820591484295766016,"amount_dec":100,"timestamp":1628909085000,"signature":9117bd1e5587e8318456e52e091136f1eb84ffebc1f2b9656573344962acc81a}'
 https://mapi.matrixport.com/eth-two/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 /eth-two/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/eth-two/api/v2/order/result?serial_number=6820608333133701120&timestamp=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 fixed-staking order list; use parameters to filter
GET /eth-two/api/v2/orders
Request Parameters
- Request Parameter Location: query_string

Parameter Name	Type	Mandatory	Limit	Description
order_status	array	N	-	Order Status: 1(Pre-order), 2(Processing), 3(Canceled, Final), 4(Holding),5(Pending),6(Settling),7(Settled, 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.
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/eth-two/api/v2/orders?order_status=4&timestamp=1627021721000&signature=d58a54d7921187bf81a0e9d028cf460f70c3c83faba7f0e9abee054e7f7bfcd1"

{
  "code": 0,
    "data": {
    "count": 1, //integer, Count of Orders
    "items": [
      {
        "id": "6955835414036922368", //string, Order ID
        "batch_no": "ETH2_0_leverage_staking400ETH2022-07-22_00:00:00-460672110000000", //string, Batch number
        "product_id": "6955834008408211456", //integer, Product ID
        "currency": "ETH", //string, Investment Currency
        "main_product_type": 40,
        "can_redeem": 2, //integer, Can you redeem early? 0: No, 1: Yes,redeem windows
        "subject_type": "ETH2.0 leverage staking", // string, Subject type
        "confirm_share_price_time": 0, //integer, Confirm share price time
        "share_price": 0, //integer,share price, e8, eg. 1300000000 -> 1.3
        "amount_dec": "3", //decimal, Investment Amount
        "share": 0, //integer, share e8 eg. 1300000000 -> 1.3 
        "book_time": 1658400395, //integer, user book time
        "duration": {
          "type": 4,
          "end_settled_day": 0,
          "end_settled_time": 43200,
          "settle_limit": 0
        },
        "raised_time": 1658419200, //integer, raised time
        "start_closed_time": 1658419200, //integer, start closed time
        "end_closed_time": 0, //integer, end closed time
        "end_settled_time": 0, //integer, end settled time
        "raise_ror": 20000000, //integer, rased ror
        "ror": 0, //integer, actual settled ror
        "minimum_of_ror": 3000000, // 
        "maximum_of_ror": 12000000, // 
        "payback_time": 0, //integer, Order settle,Payback time    
        "redeem_share": 0, //integer, order already redeem share,order left share = share-redeem_share 
        "payback_dec": "0", //decimal, payback amount
        "is_redeem": 0,
        "order_status": 20,
        "i18n": [
          {
            "id": 63956,
            "product_id": "6955834008408211456",
            "language": "en",
            "name": "staking prodicut",
            "introduction": "test",
            "basic_rule": "test"
          }
        ],
        "redeeming_share": 0, //integer, redeeming share
        "next_redeem_start_time": 0, //integer, next redeem windows start time 
        "next_redeem_end_time": 0, //integer, next redeem windows end time 
        "hold_days": 0, //integer,hold days 
        "estimate_year_ror": 0, //integer
        "last_share_price": 126000000, //integer, last share price
        "last_share_value": 101613235, //integer, last share value
        "last_apy": 4000000, //integer, last apy
        "last_share_price_update_time": 1665417600, //integer, last share time
        "hold_profit": "0", //integer, hold profit(ETH)
        "hold_steth_profit": "0", //integer, hold profit(stETH)
        "hold_ror": 0 //integer,hold ror
      }
    ]
  },
  "message": ""
}

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.currency	string	Investment Currency
items.main_product_type	integer	Main Product Type 40 ETH2.0 & ETH2.0 Leverage Staking
items.can_redeem	integer	Can you redeem early? 0: No, 1: Yes,2: redeem windows
items.subject_type	string	Subject type,ETH2.0 or ETH2.0 leverage staking
items.confirm_share_price_time	integer	Confirm share price time
items.share_price	integer	Share price
items.amount_dec	decimal	Investment Amount
items.share	integer	Share
items.book_time	integer	Book time
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.raised_time	integer	Raised 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
items.raise_ror	integer	Real rate of return(order settled status), e8
items.ror	integer	Real rate of return(order settled status), e8
items.minimum_of_ror	integer	3000000, e8
items.maximum_of_ror	integer	12000000, e8
items.payback_time	integer	Order settle,Payback time
items.redeem_share	integer	Redeemed share
items.payback_dec	decimal	Actual Payback amount
items.is_redeem	integer	Is order in redeeming
items.order_status	integer	Order Status: 1(Pre-order), 2(Processing), 3(Canceled, Final), 4(Holding),5(Pending),6(Settling),7(Settled, 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_share	integer	Redeeming share (amount pending approval and processing)
items.next_redeem_start_time	integer	Next redeem windows start time
items.next_redeem_end_time	integer	Next redeem windows end time
items.hold_days	integer	hold days
items.estimate_year_ror	integer	Estimate year apy
items.last_share_price	integer	Last share price e8
items.last_share_value	integer	Last share value e8
items.last_apy	integer	Last share ti apy
items.last_share_price_update_time	integer	Last share price time
items.hold_profit	integer	Hold profit
items.hold_steth_profit	integer	Hold stETH profit
items.hold_ror	decimal	Hold ror

Order Details

Interface Description:
- Query detailed information a designated order.
GET /eth-two/api/v2/order
Request Parameters
- Request Parameter Location: query_string

Parameter Name	Type	Mandatory	Limit	Description
order_id	string	Y	64	Order ID: 6955835414036922368

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/eth-two/api/v2/order?order_id=6955835414036922368&timestamp=1627021721000&signature=d58a54d7921187bf81a0e9d028cf460f70c3c83faba7f0e9abee054e7f7bfcd1"

{
    "code": 0,
    "data": {
      "id": "6955835414036922368", //string, Order ID
      "batch_no": "ETH2_0_leverage_staking400ETH2022-07-22_00:00:00-460672110000000", //string, Batch number
      "product_id": "6955834008408211456", //integer, Product ID
      "currency": "ETH", //string, Investment Currency
      "main_product_type": 40,
      "can_redeem": 2, //integer, Can you redeem early? 0: No, 1: Yes,redeem windows
      "subject_type": "ETH2.0 leverage staking", // string, Subject type
      "confirm_share_price_time": 0, //integer, Confirm share price time
      "share_price": 0, //integer,share price, e8, eg. 1300000000 -> 1.3
      "amount_dec": "3", //decimal, Investment Amount
      "share": 0, //integer, share e8 eg. 1300000000 -> 1.3 
      "book_time": 1658400395, //integer, user book time
      "duration": {
      "type": 4,
        "end_settled_day": 0,
        "end_settled_time": 43200,
        "settle_limit": 0
      },
      "raised_time": 1658419200, //integer, raised time
      "start_closed_time": 1658419200, //integer, start closed time
      "end_closed_time": 0, //integer, end closed time
      "end_settled_time": 0, //integer, end settled time
      "raise_ror": 20000000, //integer, rased ror
      "ror": 0, //integer, actual settled ror
      "minimum_of_ror": 3000000, // 
      "maximum_of_ror": 12000000, // 
      "payback_time": 0, //integer, Order settle,Payback time    
      "redeem_share": 0, //integer, order already redeem share,order left share = share-redeem_share 
      "payback_dec": "0", //decimal, payback amount
      "is_redeem": 0,
      "order_status": 20,
      "i18n": [
        {
          "id": 63956,
          "product_id": "6955834008408211456",
          "language": "en",
          "name": "staking二级产品码222",
          "introduction": "test",
          "basic_rule": "test"
        }
      ],
      "redeeming_share": 0, //integer, redeeming share
      "next_redeem_start_time": 0, //integer, next redeem windows start time 
      "next_redeem_end_time": 0, //integer, next redeem windows end time 
      "hold_days": 0, //integer,hold days 
      "estimate_year_ror": 0, //integer
      "last_share_price": 126000000, //integer, last share price
      "last_share_value": 101613235, //integer, last share value
      "last_apy": 4000000, //integer, last apy
      "last_share_price_update_time": 1665417600, //integer, last share time
      "hold_profit": "0", //integer, hold profit(ETH)
      "hold_steth_profit": "0", //integer, hold profit(stETH)
      "hold_ror": 0 //integer,hold ror
    },
    "message": ""
}

Parameter Name	Type	Description
id	string	Order ID
batch_no	string	Batch number
product_id	integer	Product ID
currency	string	Investment Currency
main_product_type	integer	Main Product Type 40 ETH2.0 & ETH2.0 Leverage Staking
can_redeem	integer	Can you redeem early? 0: No, 1: Yes,2: redeem windows
subject_type	string	Subject type,ETH2.0 or ETH2.0 leverage staking
confirm_share_price_time	integer	Confirm share price time
share_price	integer	Share price
amount_dec	decimal	Investment Amount
share	integer	Share
book_time	integer	Book time
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
raised_time	integer	Raised time
start_closed_time	integer	Close Start Time
end_closed_time	integer	Close End Time
end_settled_time	integer	Closing Time for Settlement
raise_ror	integer	Real rate of return(order settled status), e8
ror	integer	Real rate of return(order settled status), e8
minimum_of_ror	integer	3000000, e8
maximum_of_ror	integer	12000000, e8
payback_time	integer	Order settle,Payback time
redeem_share	integer	Redeemed share
payback_dec	decimal	Actual Payback amount
is_redeem	integer	Is order in redeeming
order_status	integer	Order Status: 1(Pre-order), 2(Processing), 3(Canceled, Final), 4(Holding),5(Pending),6(Settling),7(Settled, 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_share	integer	Redeeming share (amount pending approval and processing)
next_redeem_start_time	integer	Next redeem windows start time
next_redeem_end_time	integer	Next redeem windows end time
hold_days	integer	hold days
estimate_year_ror	integer	Estimate year apy
last_share_price	integer	Last share price e8
last_share_value	integer	Last share value e8
last_apy	integer	Last share ti apy
last_share_price_update_time	integer	Last share price time
hold_profit	integer	Hold profit
hold_steth_profit	integer	Hold stETH profit
hold_ror	decimal	Hold ror

Order Redeem Amount

Interface Description:
- Query max share to redeem order.
GET /eth-two/api/v2/order/redeem/amount
Request Parameters
- Request Parameter Location: query_string

Parameter Name	Type	Mandatory	Limit	Description
order_id	string	Y	64	Order ID: 6954077761807892480

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//eth-two/api/v2/order/redeem/amount?order_id=6954077761807892480&timestamp=1627021721000&signature=d58a54d7921187bf81a0e9d028cf460f70c3c83faba7f0e9abee054e7f7bfcd1"

{
    "code": 0,
    "data": {
        "order_id": "6954077761807892480",
        "max_amount": 2043000001,
        "max_share": 2002941176,
        "max_amount_dec": "20.43000001"
    },
    "message": ""
}

Parameter Name	Type	Description
max_share	integer	Max amount share can redeem

Order Redeem

Interface Description: Order confirm share and on redeem windows,user can redeem share.
POST /eth-two/api/v2/order/redeem
Request Parameters
- Request Parameter Location: body/JSON

Parameter Name	Type	Mandatory	Limit	Description
payback_currency	string	Y		ETH or STETH
order_id	string	Y	-	Order ID
share	integer	Y	-	Share amount want to redeem
principal	integer	Y	-	Redeem Share's Principal = share*(order's share_price)

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 '{"payback_currency": "ETH","order_id": "6954077761807892480","share": 500735294,"principal": 510749999,"signature":"9117bd1e5587e8318456e52e091136f1eb84ffebc1f2b9656573344962acc81a"}'
 https://mapi.matrixport.com/eth-two/api/v2/order/redeem

{
  "code": 0,
    "data": {
    "id": 8988, //integer, redeem order id 
      "order_id": "6954077761807892480", // string, order id
      "ror": 1000000, //integer,actual redeem settled ror(if the status not success,is't a estimate value)
      "redeem_time": 1665749728, //integer,user redeem time
      "main_product_type": 40,
      "confirm_time": 0, //integer, redeem confirm time 
      "redeem_currency": "ETH", //string, redeem currency
      "redeem_share": 500735294, //integer, redeem share
      "redeem_share_price": 0, //integer, redeem confirm share price
      "redeem_share_price_time": 0, //integer, redeem confirm share price's time
      "status": 1, //redeem status  1:create redeem order; 2:redeem success; 3:redeem cancel; 4.redeem processing
      "redeem_principal_dec": "5.10749999", //decimal,redeem principal
      "redeem_profit_dec": "0", //decimal,profit
      "redeem_demand_interest_dec": "0", //decimal,raised period interest
      "coupon_profit_dec": "0", //decimal,coupon profit
      "redeem_amount_dec": "5.120187113262831049", //decimal,redeem payback amount(if the status not success,is't a estimate value)
      "payback_currency": "ETH", //string,payback currency,user can select STETH payback
      "client_repay_amount_dec": "0" //decimal,client repay amount,only eth2.0 leverage staking support
  },
  "message": ""
}

Parameter Name	Type	Description
id	integer	Redeem order id
order_id	string	Order id
ror	integer	Actual redeem settled ror(if the status not success,is't a estimate value)
redeem_time	integer	User redeem time
main_product_type	integer
confirm_time	integer	Redeem confirm time
redeem_currency	string	Redeem currency
redeem_share	integer	Redeem share
redeem_share_price	integer	Redeem confirm share price
redeem_share_price_time	integer	Redeem confirm share price's time
status	integer	Redeem status 1:create redeem order; 2:redeem success; 3:redeem cancel; 4.redeem processing
redeem_principal_dec	decimal	Redeem principal
redeem_profit_dec	decimal	Redeem profit
redeem_demand_interest_dec	decimal	Raised period interest
coupon_profit_dec	decimal	Coupon profit
redeem_amount_dec	decimal	Redeem payback amount(if the status not success,is't a estimate value)
payback_currency	string	Payback currency,user can select STETH payback
client_repay_amount_dec	decimal	Client repay amount,only eth2.0 leverage staking support

Order Redeem Detail

Interface Description:
- Query order redeem details.
GET /eth-two/api/v2/order/redeem/detail
Request Parameters
- Request Parameter Location: query_string

Parameter Name	Type	Mandatory	Limit	Description
order_id	string	Y	64	Order ID: 6955835414036922368

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//eth-two/api/v2/order/redeem/detail?order_id=6955835414036922368&timestamp=1627021721000&signature=d58a54d7921187bf81a0e9d028cf460f70c3c83faba7f0e9abee054e7f7bfcd1"

{
  "code": 0,
    "data": {
    // only order settled(order status=7) will returen the order_payback
    "order_payback": {
      "currency": "ETH", //string,currency
        "ror": 91530000, //integer,settled ror
        "payback_time": 1665719255, //integer,payback time
        "settle_payback_dec": "610.33753428319559452" //decimal,settle payback amount
    },
    "redeem_orders": [
      {
        "id": 8988, //integer, redeem order id 
        "order_id": "6954077761807892480", // string, order id
        "ror": 1000000, //integer,actual redeem settled ror(if the status not success,is't a estimate value)
        "redeem_time": 1665749728, //integer,user redeem time
        "main_product_type": 40,
        "confirm_time": 0, //integer, redeem confirm time 
        "redeem_currency": "ETH", //string, redeem currency
        "redeem_share": 500735294, //integer, redeem share
        "redeem_share_price": 0, //integer, redeem confirm share price
        "redeem_share_price_time": 0, //integer, redeem confirm share price's time
        "status": 1, //redeem status  1:create redeem order; 2:redeem success; 3:redeem cancel; 4.redeem processing
        "redeem_principal_dec": "5.10749999", //decimal,redeem principal
        "redeem_profit_dec": "0", //decimal,profit
        "redeem_demand_interest_dec": "0", //decimal,raised period interest
        "coupon_profit_dec": "0", //decimal,coupon profit
        "redeem_amount_dec": "5.120187113262831049", //decimal,redeem payback amount(if the status not success,is't a estimate value)
        "payback_currency": "ETH", //string,payback currency,user can select STETH payback
        "client_repay_amount_dec": "0" //decimal,client repay amount,only eth2.0 leverage staking support
      }
    ],
      "profit_ror": 20468558,//integer,profit ror
      "steth_profit_ror": 22695963,//integer,steth profit ror
      "steth_avg_price": 0,//integer,steth avg price
      "slippage_avg_ror": 0,//integer,slippage avg ror
      "platform_fee_ror": 0,//integer,platform fee ror
      "redeem_fee_ror": 2000000,//integer,redeem fee ror
      "redeeming_amount_dec": "0", //decimal,redeeming amount
      "profit_dec": "511.713972607353095889", //decimal,eth profit
      "steth_profit_dec": "340.439452050262158904", //decimal,steth profit
      "steth_payback_dec": "1940.439452030262158904",//decimal, steth payback amount(user select steth payback when redeem)
      "redeem_fee_dec": "69.999999999881281408" //decimal,redeem fee 
  },
  "message": ""
}

Parameter Name	Type	Description
order_payback	object
order_payback.currency	string
order_payback.ror	integer	Max amount share can redeem
order_payback.payback_time	integer	Max amount share can redeem
order_payback.settle_payback_dec	decimal	Max amount share can redeem
redeem_orders	array	redeem orders
redeem_orders.id	integer	Redeem order id
redeem_orders.order_id	string	Order id
redeem_orders.ror	integer	Actual redeem settled ror(if the status not success,is't a estimate value)
redeem_orders.redeem_time	integer	User redeem time
redeem_orders.main_product_type	integer
redeem_orders.confirm_time	integer	Redeem confirm time
redeem_orders.redeem_currency	string	Redeem currency
redeem_orders.redeem_share	integer	Redeem share
redeem_orders.redeem_share_price	integer	Redeem confirm share price
redeem_orders.redeem_share_price_time	integer	Redeem confirm share price's time
redeem_orders.status	integer	Redeem status 1:create redeem order; 2:redeem success; 3:redeem cancel; 4.redeem processing
redeem_orders.redeem_principal_dec	decimal	Redeem principal
redeem_orders.redeem_profit_dec	decimal	Redeem profit
redeem_orders.redeem_demand_interest_dec	decimal	Raised period interest
redeem_orders.coupon_profit_dec	decimal	Coupon profit
redeem_orders.redeem_amount_dec	decimal	Redeem payback amount(if the status not success,is't a estimate value)
redeem_orders.payback_currency	string	Payback currency,user can select STETH payback
redeem_orders.client_repay_amount_dec	decimal	Client repay amount,only eth2.0 leverage staking support
profit_ror	integer	profit ror
steth_profit_ror	integer	steth profit ror
steth_avg_price	integer	steth avg price
slippage_avg_ror	integer	slippage avg ror
platform_fee_ror	integer	platform fee ror
redeem_fee_ror	integer	redeem fee ror
redeeming_amount_dec	decimal	redeeming amount
profit_dec	decimal	eth profit
steth_profit_dec	decimal	steth profit
steth_payback_dec	decimal	steth payback amount(user select steth payback when redeem)
redeem_fee_dec	decimal	redeem fee

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.