API docs by Redocly

Finary API (0.1.0)

Download OpenAPI specification:Download

Finary Support: hello@finary.com URL: http://community.finary.com License: MIT

Finary API to interact with a user account.

general

resources non specific to a user

Authenticate the user

Authenticate the user

Request Body schema: application/json
email
required
string
password
required
string
device_id
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string",
  • "device_id": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": {
    },
  • "result": {
    }
}

Get the supported crypto chains

Get the supported crypto chains that can be used when a user enters his wallet adress

Authorizations:
finary_access_token

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": {
    },
  • "result": [
    ]
}

Get the available bank account types, given a type of bank account (invest / cash)

Get the available bank account types, given a type of bank account (invest / cash)

Authorizations:
finary_access_token
query Parameters
type
string
Enum: "invest" "cash"

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": {
    },
  • "result": [
    ]
}

Get the currencies for a given type and query

Get the currencies for a given type (crypto or crypto) and a query

Authorizations:
finary_access_token
query Parameters
type
string
Enum: "crypto" "fiat"
query
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": {
    },
  • "result": [
    ]
}

Get the generic asset categories

Get the generic asset categories used to populate the dropbox in the generic asset UI.

Authorizations:
finary_access_token

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": {
    },
  • "result": [
    ]
}

Search precious metal in Finary database

Search precious metal in Finary database

Authorizations:
finary_access_token
query Parameters
query
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": {
    },
  • "result": [
    ]
}

Search scpis in Finary Database

Search scpis in Finary Database

Authorizations:
finary_access_token
query Parameters
query
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": {
    },
  • "result": [
    ]
}

Search securities in Finary Database

Search securities in Finary Database

Authorizations:
finary_access_token
query Parameters
query
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": {
    },
  • "result": [
    ]
}

user

resources specific to a user

Get the logged in user

Get the logged in user

Authorizations:
finary_access_token

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": {
    },
  • "result": {
    }
}

Search institution with given name, also among user created ones?

Search institution with given name, also among user created ones?

Authorizations:
finary_access_token
query Parameters
name
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": {
    },
  • "result": [
    ]
}

Get the logged in user's institution connections

Get the logged in user's institution connections

Authorizations:
finary_access_token

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": {
    },
  • "result": {
    }
}

Get logged in user cryptos

Get logged in user cryptos

Authorizations:
finary_access_token

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": {
    },
  • "result": [
    ]
}

Create a crypto entry in crypto account

Create a crypto entry in crypto account

Authorizations:
finary_access_token
Request Body schema: application/json
correlation_id
required
string
quantity
required
number
buying_price
required
number
required
object

Responses

Request samples

Content type
application/json
{
  • "correlation_id": "string",
  • "quantity": 0,
  • "buying_price": 0,
  • "holdings_account": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": {
    },
  • "result": {
    }
}

Get a crypto line by CryptoId

Get a crypto line by CryptoId

Authorizations:
finary_access_token
path Parameters
CryptoId
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": {
    },
  • "result": {
    }
}

Update a crypto line by CryptoId

Update a crypto line by CryptoId

Authorizations:
finary_access_token
path Parameters
CryptoId
required
integer
Request Body schema: application/json
id
required
integer
required
object (Currency)
owning_type
required
string
Enum: "hodled" "stacked"
quantity
required
number
current_price
required
number
display_current_price
required
number
buying_price
required
number
required
object (Currency)
display_buying_price
required
number
current_value
required
number
display_current_value
required
number
unrealized_pnl
required
number
display_unrealized_pnl
required
number
unrealized_pnl_percent
required
number
required
object (Currency)
object (HoldingsAccount)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "crypto": {
    },
  • "owning_type": "hodled",
  • "quantity": 0,
  • "current_price": 0,
  • "display_current_price": 0,
  • "buying_price": 0,
  • "buying_price_currency": {
    },
  • "display_buying_price": 0,
  • "current_value": 0,
  • "display_current_value": 0,
  • "unrealized_pnl": 0,
  • "display_unrealized_pnl": 0,
  • "unrealized_pnl_percent": 0,
  • "display_currency": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": {
    },
  • "result": {
    }
}

Delete a crypto line by CryptoId

Delete a crypto line by CryptoId

Authorizations:
finary_access_token
path Parameters
CryptoId
required
integer

Responses

Get logged user startups

Get logged user startups

Authorizations:
finary_access_token

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": {
    },
  • "result": {
    }
}

Get logged in user generic assets

Get logged in user generic assets

Authorizations:
finary_access_token

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": {
    },
  • "result": [
    ]
}

Create a generic asset entry

Create a generic asset entry

Authorizations:
finary_access_token
Request Body schema: application/json
name
required
string
category
required
string
quantity
required
number
buying_price
required
number
current_price
required
number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "category": "string",
  • "quantity": 0,
  • "buying_price": 0,
  • "current_price": 0
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": {
    },
  • "result": {
    }
}

Get a generic asset by id

Get a generic asset by id

Authorizations:
finary_access_token
path Parameters
GenericAssetId
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": {
    },
  • "result": {
    }
}

Update a generic asset by id

Update a generic asset by id

Authorizations:
finary_access_token
path Parameters
GenericAssetId
required
integer
Request Body schema: application/json
id
required
integer
name
required
string
updated_at
required
string
category
required
string

A Generic Asset Category as returned by the generic_asset_categories resource

quantity
required
number
buying_price
required
number
display_buying_price
required
number
current_price
required
number
display_current_price
required
number
current_value
required
number
display_current_value
required
number
unrealized_pnl
required
number
display_unrealized_pnl
required
number
unrealized_pnl_percent
required
number
required
object (Currency)
required
object (Currency)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "updated_at": "string",
  • "category": "string",
  • "quantity": 0,
  • "buying_price": 0,
  • "display_buying_price": 0,
  • "current_price": 0,
  • "display_current_price": 0,
  • "current_value": 0,
  • "display_current_value": 0,
  • "unrealized_pnl": 0,
  • "display_unrealized_pnl": 0,
  • "unrealized_pnl_percent": 0,
  • "display_currency": {
    },
  • "currency": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": {
    },
  • "result": {
    }
}

Delete a generic asset by id

Delete a generic asset by id

Authorizations:
finary_access_token
path Parameters
GenericAssetId
required
integer

Responses

Get the holdings accounts of the current user

Get the holdings accounts of the current user

Authorizations:
finary_access_token
query Parameters
manual_type
string
Enum: "crypto" "stocks"

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": {
    },
  • "result": [
    ]
}

Get the SCPIs of the current user

Get the SCPIs of the current user

Authorizations:
finary_access_token

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": {
    },
  • "result": [
    ]
}

Get the Fonds Euro for the current user

Get the Fonds Euro for the current user

Authorizations:
finary_access_token

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": {
    },
  • "result": [
    ]
}

Get the Securities of the current user

Get the Securities of the current user

Authorizations:
finary_access_token

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": {
    },
  • "result": [
    ]
}