Documentation de l'API

• Bank accounts
  • getGet bank accounts of an investor
  • getGet bank account
• Investors
  • getGet all investors' infos
  • getGet investor info
• Subscription orders
  • getGet subscription orders
  • postCreate subscription order
  • getGet subscription order
• Redemption orders
  • getGet redemption orders
  • postCreate redemption order
  • getGet redemption order
• Portfolio
  • getGet portfolio

API docs by Redocly

Spiko Investor Api (v1)

Download OpenAPI specification:Download

Bank accounts

Get bank accounts of an investor

Get list of bank account's info of an investor (IBAN / BIC)

query Parameters

investorId required

string^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... a Universally Unique Identifier

Responses

https://investor-api.spiko.finance/v1/bank-accounts/

Response samples

• 200

Content type

application/json

[

• {

  • "id": "string",
  • "investorId": "string",
  • "name": "string",
  • "details": {

    • "currency": "EUR",
    • "accountNumber": { },
    • "bic": null

    }

  }

]

Get bank account

Get info of a bank account (currency / IBAN / BIC)

path Parameters

bankAccountId required

string^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... a Universally Unique Identifier

Responses

https://investor-api.spiko.finance/v1/bank-accounts/{bankAccountId}

Response samples

• 200

Content type

application/json

{

• "id": "string",
• "investorId": "string",
• "name": "string",
• "details": {

  • "currency": "EUR",
  • "accountNumber": { },
  • "bic": null

  }

}

Investors

Get all investors' infos

Get info about all available investors

Responses

https://investor-api.spiko.finance/v1/investors

Response samples

• 200

Content type

application/json

[

• {

  • "id": "string",
  • "name": "string",
  • "address": "string",
  • "zipCode": "string",
  • "city": "string",
  • "country": "AF",
  • "type": "individual",
  • "countryOfTaxResidence": "AF"

  }

]

Get investor info

Get info about an investor

path Parameters

investorId required

string^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... a Universally Unique Identifier

Responses

https://investor-api.spiko.finance/v1/investors/{investorId}

Response samples

• 200

Content type

application/json

{

• "id": "string",
• "name": "string",
• "address": "string",
• "zipCode": "string",
• "city": "string",
• "country": "AF",
• "type": "organization",
• "registrationNumber": "string",
• "legalEntityType": "string"

}

Subscription orders

Get subscription orders

Get list of an investor's subscription orders

query Parameters

investorId required	string^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... a Universally Unique Identifier
status	Array of strings Items Enum: "pending" "executed"

Responses

https://investor-api.spiko.finance/v1/subscription-orders/

Response samples

• 200

Content type

application/json

[

• {

  • "id": "string",
  • "investorId": "string",
  • "amount": {

    • "value": null,
    • "currency": "EUR"

    },
  • "sharesAmount": "string",
  • "shareClassId": "string",
  • "wireReference": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "executedAt": "2019-08-24T14:15:22Z",
  • "status": "pending"

  }

]

Create subscription order

Create a new subscription order for an investor and return the order info

Request Body schema: application/json

required

investorId required	string^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... a Universally Unique Identifier
required	object (NonNegativeAmount)
shareClassId required	string^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... a Universally Unique Identifier

Responses

https://investor-api.spiko.finance/v1/subscription-orders/

Request samples

• Payload

Content type

application/json

{

• "investorId": "string",
• "amount": {

  • "value": null,
  • "currency": "EUR"

  },
• "shareClassId": "string"

}

Response samples

• 200

Content type

application/json

{

• "id": "string",
• "investorId": "string",
• "amount": {

  • "value": null,
  • "currency": "EUR"

  },
• "sharesAmount": "string",
• "shareClassId": "string",
• "wireReference": "string",
• "createdAt": "2019-08-24T14:15:22Z",
• "executedAt": "2019-08-24T14:15:22Z",
• "status": "pending"

}

Get subscription order

Get info of a subscription order

path Parameters

subscriptionOrderId required

string^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... a Universally Unique Identifier

Responses

https://investor-api.spiko.finance/v1/subscription-orders/{subscriptionOrderId}

Response samples

• 200

Content type

application/json

{

• "id": "string",
• "investorId": "string",
• "amount": {

  • "value": null,
  • "currency": "EUR"

  },
• "sharesAmount": "string",
• "shareClassId": "string",
• "wireReference": "string",
• "createdAt": "2019-08-24T14:15:22Z",
• "executedAt": "2019-08-24T14:15:22Z",
• "status": "pending"

}

Redemption orders

Get redemption orders

Get list of an investor's redemption orders

query Parameters

investorId required	string^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... a Universally Unique Identifier
status	Array of strings Items Enum: "pending" "executed"

Responses

https://investor-api.spiko.finance/v1/redemption-orders/

Response samples

• 200

Content type

application/json

[

• {

  • "id": "string",
  • "investorId": "string",
  • "shareClassId": "string",
  • "sharesAmount": "string",
  • "amount": {

    • "value": null,
    • "currency": "EUR"

    },
  • "bankAccountId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "executedAt": "2019-08-24T14:15:22Z",
  • "status": "pending"

  }

]

Create redemption order

Create a new redemption order for an investor and return the order info

Request Body schema: application/json

required

investorId required	string^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... a Universally Unique Identifier
required	object (NonNegativeAmount)
shareClassId required	string^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... a Universally Unique Identifier
bankAccountId required	string^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... a Universally Unique Identifier

Responses

https://investor-api.spiko.finance/v1/redemption-orders/

Request samples

• Payload

Content type

application/json

{

• "investorId": "string",
• "amount": {

  • "value": null,
  • "currency": "EUR"

  },
• "shareClassId": "string",
• "bankAccountId": "string"

}

Response samples

• 200

Content type

application/json

{

• "id": "string",
• "investorId": "string",
• "shareClassId": "string",
• "sharesAmount": "string",
• "amount": {

  • "value": null,
  • "currency": "EUR"

  },
• "bankAccountId": "string",
• "createdAt": "2019-08-24T14:15:22Z",
• "executedAt": "2019-08-24T14:15:22Z",
• "status": "pending"

}

Get redemption order

Get info of a redemption order

path Parameters

redemptionOrderId required

string^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... a Universally Unique Identifier

Responses

https://investor-api.spiko.finance/v1/redemption-orders/{redemptionOrderId}

Response samples

• 200

Content type

application/json

{

• "id": "string",
• "investorId": "string",
• "shareClassId": "string",
• "sharesAmount": "string",
• "amount": {

  • "value": null,
  • "currency": "EUR"

  },
• "bankAccountId": "string",
• "createdAt": "2019-08-24T14:15:22Z",
• "executedAt": "2019-08-24T14:15:22Z",
• "status": "pending"

}

Portfolio

Get portfolio

Get the investor's portfolio

query Parameters

investorId required

string^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... a Universally Unique Identifier

Responses

https://investor-api.spiko.finance/v1/portfolio/

Response samples

• 200

Content type

application/json

{

• "investorId": "string",
• "items": [

  • {

    • "shareClass": {

      • "id": "string",
      • "name": "string",
      • "isin": "string"

      },
    • "totalNumberOfShares": "string",
    • "totalSharesAmount": {

      • "value": null,
      • "currency": "EUR"

      },
    • "totalGainSinceStart": {

      • "value": null,
      • "currency": "EUR"

      }

    }

  ]

}