Create Clients
Use this endpoint to register new clients
POST
https://ecn.afexnigeria.com/AFEXOVS/api/v1/client/create/multiple
This endpoint is used to register new clients on the ECN through an OMS. A list of objects is expected to be passed as the request body.
Request body (Plain):
Request Body
Copy {
"message": "Transaction submitted successfully, some data passed validation. Now submitted for approval. Pls do check the failed_data key for data that was rejected by validation",
"responseCode": "100",
"request_id": "2020-04-29T11:39:27.747964",
"failed_data": []
}
List Clients
Use this endpoint to fetch a list of clients attached to your OMS
GET
https://ecn.afexnigeria.com/AFEXOVS/api/v1/clients
This endpoint list all the client account registered with the OMS provider.
Copy {
"responseCode": "100",
"message": "Wallets",
"data": [
{
"cid": "fm51huVCfZLXEI0Cpxrvyw==",
"total_balance": "FDrpJnSksuY37Ykz8EwV1Q==",
"available_balance": "kZgw6vyxbKg1C9L7wlb/OQ==",
"lien_balance": "KCkSNijreYFHqiay09Ra8w==",
"updated": "+MUwSH7wbN/O8TqdGrErmw==",
}
]
}
Client Wallet
Use this endpoint to pull a list of all clients attached to your OMS and their wallet positions
GET
https://ecn.afexnigeria.com/AFEXOVS/api/v1/wallets
Copy {
"responseCode": "100",
"message": "Wallets",
"data": [
{
"cid": "fm51huVCfZLXEI0Cpxrvyw==",
"total_balance": "FDrpJnSksuY37Ykz8EwV1Q==",
"available_balance": "kZgw6vyxbKg1C9L7wlb/OQ==",
"lien_balance": "KCkSNijreYFHqiay09Ra8w==",
"updated": "+MUwSH7wbN/O8TqdGrErmw==",
}
]
}
Client Portfolio
Use this endpoint to pull a list of all clients attached to your OMS and their Portfolio positions
GET
https://ecn.afexnigeria.com/AFEXOVS/api/v1/portfolio
This endpoint list all the client securities that are connected to the OMS provider.
Copy {
"responseCode": "100",
"message": "Clients Security Account",
"data": [
{
"cid": "04xxMRrISsu/jOpOeNQhjw==",
"security_code": "3xo/tiEDdgarZ2bEq+ftgw==",
"total_units": "Hm++Ob58TL63BRpCFUTkiQ==",
"available_units": "Hm++Ob58TL63BRpCFUTkiQ==",
"units_on_hold": "JuGw5qEvWwMAojgcC3EpMw==",
"updated": "iSk6oHd8ypOmXacFTNmhQ6fsc1OeThShqjk2kX47HX8="
},
{
"cid": "04xxMRrISsu/jOpOeNQhjw==",
"security_code": "CBEUIyUBVGH6z19VxlduBQ==",
"total_units": "zM+5SwtQUVyCFfmu8zPRpw==",
"available_units": "zM+5SwtQUVyCFfmu8zPRpw==",
"units_on_hold": "JuGw5qEvWwMAojgcC3EpMw==",
"updated": "M+Bhz4G5als9HKjhLoco7F2xfW5tiSq2NdqUA0CpV/0="
}
]
}
Single Client Portfolio
Use this endpoint to pull the portfolio position of a specific client
This endpoint list all securities belonging to a particular client.
GET
https://ecn.afexnigeria.com/AFEXOVS/api/v1/portfolio/{client_cid}
Path Parameters
Copy {
"responseCode": "100",
"message": "Client Security Account",
"data": [
{
"cid": "04xxMRrISsu/jOpOeNQhjw==",
"security_code": "3xo/tiEDdgarZ2bEq+ftgw==",
"total_units": "Hm++Ob58TL63BRpCFUTkiQ==",
"available_units": "Hm++Ob58TL63BRpCFUTkiQ==",
"units_on_hold": "JuGw5qEvWwMAojgcC3EpMw==",
"updated": "iSk6oHd8ypOmXacFTNmhQ6fsc1OeThShqjk2kX47HX8="
},
{
"cid": "04xxMRrISsu/jOpOeNQhjw==",
"security_code": "CBEUIyUBVGH6z19VxlduBQ==",
"total_units": "zM+5SwtQUVyCFfmu8zPRpw==",
"available_units": "zM+5SwtQUVyCFfmu8zPRpw==",
"units_on_hold": "JuGw5qEvWwMAojgcC3EpMw==",
"updated": "M+Bhz4G5als9HKjhLoco7F2xfW5tiSq2NdqUA0CpV/0="
}
]
}