![\"Buy](\"https://cdn.buymeacoffee.com/buttons/default-orange.png\")
\n\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nThis is an unofficial TypeScript API client (Backend & Frontend) for DeGiro's trading platform. Using this module you can easily automate your orders (buy and sell) and get information about orders, funds or products.
\n\t\t\t\tAll responses and objects are typed to develop faster and secure.
\n\t\t\t\t![\"DeGiro](\"https://raw.githubusercontent.com/icastillejogomez/degiro-api/master/.assets/degiro.png\")
\n\t\t\t\t\t
\n\t\t\t\t
# using npm\nnpm install --save degiro-api\n\n# using yarn\nyarn add degiro-apiBasic log into DeGiro Platform. All endpoint needs a session key before those can be call them. You can pass credentials to DeGiro constructor or export in your terminal prompt sesion as DEGIRO_USER and DEGIRO_PWD
const DeGiro = require('degiro-api')\n\nconst degiro = new DeGiro({\n username: 'username',\n pwd: '*****'\n})\n\ndegiro.login()\n .then((accountData) => console.log('Log in success\\n', accountData))\n .catch(console.error)\n\n// or creating with the static create method\n\nconst degiro = DeGiro.create({ username: '*****', pwd: '*****' })\nconst accountData = await degiro.login()\n\n// or create with env credentials\n\nconst degiro = new DeGiro() // <-- Use DEGIRO_USER & DEGIRO_PWD\nconst accountData = await degiro.login()$ export DEGIRO_DEBUG=1\n$ yarn startRun the next command and open index.html file inside doc folder.
\n\t\t\t\t$ yarn doc\nyarn run v1.22.4\n$ typedoc --out docs src\n\nUsing TypeScript 3.9.2 from ....../degiro-api/node_modules/typescript/lib\nRendering [========================================] 100%\n\nDocumentation generated at ....../degiro-api/docs\n\n✨ Done in 3.94s.Before run the test set you must set DEGIRO_USER & DEGIRO_PWD env export variables to attach an account to the test sets.
\n\t\t\t\t$ yarn install && yarn test\nyarn run v1.22.4\n$ mocha -r ts-node/register tests/**/*.spec.ts\n\n\n Environment variables\n ✓ DEGIRO_USER env var should exists\n ✓ DEGIRO_PWD env var should exists\n\n Create DeGiro instance\n ✓ should create an instance of DeGiro class from env vars\n ✓ should create an instance of DeGiro class from constructor params\n\n DeGiro login process\n ✓ should successfully log in with environment credentials (619ms)\n ✓ should return a valid account config from server (738ms)\n ✓ should return a valid account data from server (727ms)\n ✓ getJSESSIONID should return a valid jsessionId\n ✓ should login with previous jsessionId\n\n DeGiro logout process\n ✓ should successfully log out after sign in (685ms)\n\n\n 10 passing (3s)\n\n✨ Done in 5.21s.The JSessionId is the session browser cookie that DeGiro use to authenticate requests. You could prevent masive login/logout requests reusing a valid jsessionid from previous DeGiro instance. The way to do that is:
\n\t\t\t\tgetJSESSIONID(): string
import DeGiro from 'degiro-api'\n\n(async () => {\n const degiro = new DeGiro({}) // <-- Using ENV variables\n\n await degiro.login()\n\n // Get the jsessionId (LOOK, is not a promise)\n const jsessionId = degiro.getJSESSIONID()\n})()import DeGiro from 'degiro-api'\n\n(async () => {\n\n // Create an instance from a previous session\n const degiro = new DeGiro({\n username: '<your_username_here>',\n pwd: '*******',\n jsessionId: previousJSESSIONID\n })\n\n // Hydrate\n // Re-use sessions need to re-hydrate the account config data and could use as a session expiration checker\n await degiro.login()\n\n // Do your stuff here...\n\n})()isLogin(options): boolean
import DeGiro from 'degiro-api'\n\n(async () => {\n // Create an instance from a previous session\n const degiro = new DeGiro({}) // <-- Using ENV variables\n\n if (!degiro.isLogin()) {\n await degiro.login()\n if (degiro.isLogin()) {\n // AWESOME!! We're in\n }\n }\n})()The problem with this method is that it only checks if you have the account configuration data set. The only way to verify that the session is still active is make a request.\n\t\t\t\tYou can force isLogin method passing it a secure field set to true. This way the method will return a promise and below it will call a DeGiro API endpoint (usually getAccountConfig)
import DeGiro from 'degiro-api'\n\n(async () => {\n // Create an instance from a previous session\n const degiro = new DeGiro({}) // <-- Using ENV variables\n\n // Force to make a request and check if session is still alive\n if(! await degiro.isLogin({ secure: true })) {\n await degiro.login()\n }\n})()Get account info using await:
import DeGiro from 'degiro-api'\n\n(async () => {\n const degiro = new DeGiro({\n username: 'username',\n pwd: '*****'\n })\n\n await degiro.login() // Login also returns accountData\n\n const accountData = await degiro.getAccountData()\n // console.log(accountData)\n})()getPortfolio(config: GetPorfolioConfigType): Promise<any[]>
getPortfolio config parameter could have:
type: set the types or positions you want to fetch. Could be:
\n\t\t\t\t\t\tgetProductDetails: if is set to true the positions results will have a productData field with all the product details.
Get all open positions:
\n\t\t\t\timport DeGiro, { DeGiroEnums, DeGiroTypes } from 'degiro-api'\nconst { PORTFOLIO_POSITIONS_TYPE_ENUM } = DeGiroEnums\n\n(async () => {\n\n const degiro: DeGiro = new DeGiro({\n username: 'your_username_here',\n pwd: '**********',\n })\n\n await degiro.login()\n\n const portfolio = await degiro.getPortfolio({ \n type: PORTFOLIO_POSITIONS_TYPE_ENUM.ALL, \n getProductDetails: true,\n })\n console.log(JSON.stringify(portfolio, null, 2))\n})()Also you can fetch your portfolio data this way:
\n\t\t\t\timport DeGiro, { DeGiroEnums, DeGiroTypes } from 'degiro-api'\nconst { PORTFOLIO_POSITIONS_TYPE_ENUM } = DeGiroEnums\n\n(async () => {\n\n const degiro: DeGiro = new DeGiro({\n username: 'your_username_here',\n pwd: '**********',\n })\n\n await degiro.login()\n\n const portfolio = await degiro.getPortfolio({ type: PORTFOLIO_POSITIONS_TYPE_ENUM.ALL })\n console.log(JSON.stringify(portfolio, null, 2))\n})()And getting product details too
\n\t\t\t\timport DeGiro, { DeGiroEnums, DeGiroTypes } from 'degiro-api'\nconst { PORTFOLIO_POSITIONS_TYPE_ENUM } = DeGiroEnums\n\n(async () => {\n\n const degiro: DeGiro = new DeGiro({\n username: 'your_username_here',\n pwd: '**********',\n })\n\n await degiro.login()\n\n const portfolio = await degiro.getPortfolio({ \n type: PORTFOLIO_POSITIONS_TYPE_ENUM.ALL, \n getProductDetails: true,\n })\n console.log(JSON.stringify(portfolio, null, 2))\n})()degiro.searchProduct(options): Promise<SearchProductResultType[]>
DeGiroProducTypes
Search the text "AAPL" without any limitation
\n\t\t\t\timport DeGiro from 'degiro-api'\n\n(async () => {\n\n const degiro: DeGiro = new DeGiro({\n username: 'your_username_here',\n pwd: '***********',\n })\n\n await degiro.login()\n\n const result = await degiro.searchProduct({ text: 'AAPL' })\n console.log(JSON.stringify(result, null, 2))\n})()Search TSLA stock
\n\t\t\t\timport DeGiro, { DeGiroEnums, DeGiroTypes } from 'degiro-api'\nconst { DeGiroProducTypes } = DeGiroEnums\n\n(async () => {\n\n const degiro: DeGiro = new DeGiro({\n username: 'your_username_here',\n pwd: '***********',\n })\n\n await degiro.login()\n\n const result = await degiro.searchProduct({\n text: 'TSLA',\n type: DeGiroProducTypes.shares,\n limit: 1,\n })\n console.log(JSON.stringify(result, null, 2))\n})()degiro.createOrder(order: OrderType): Promise<CreateOrderResultType>
DeGiroMarketOrderTypes
\n\t\t\t\t\t\tDeGiroTimeTypes
\n\t\t\t\t\t\tCreateOrderResultType
\n\t\t\t\t\t\timport DeGiro, { DeGiroEnums, DeGiroTypes } from 'degiro-api'\nconst { DeGiroActions, DeGiroMarketOrderTypes, DeGiroTimeTypes } = DeGiroEnums\nconst { OrderType } = DeGiroTypes\n\n(async () => {\n\n const degiro: DeGiro = new DeGiro({\n username: 'your_username_here',\n pwd: '************'\n })\n\n await degiro.login()\n\n const order: OrderType = {\n buySell: DeGiroActions.BUY,\n orderType: DeGiroMarketOrderTypes.LIMITED,\n productId: '331868', // $AAPL - Apple Inc\n size: 1,\n timeType: DeGiroTimeTypes.DAY,\n price: 272, // limit price [Degiro could reject this value]\n // stopPrice: 2,\n }\n\n const { confirmationId, freeSpaceNew, transactionFees } = await degiro.createOrder(order)\n console.log(JSON.stringify({ confirmationId, freeSpaceNew, transactionFees }, null, 2))\n})()import DeGiro, { DeGiroEnums, DeGiroTypes } from 'degiro-api'\nconst { DeGiroActions, DeGiroMarketOrderTypes, DeGiroTimeTypes } = DeGiroEnums\nconst { OrderType } = DeGiroTypes\n\n(async () => {\n\n try {\n const degiro: DeGiro = new DeGiro({\n username: 'nachoogoomezomg',\n pwd: <string>process.env.DEGIRO_PWD,\n })\n\n await degiro.login()\n\n const order: OrderType = {\n buySell: DeGiroActions.BUY,\n orderType: DeGiroMarketOrderTypes.LIMITED,\n productId: '331868', // $AAPL - Apple Inc\n size: 1,\n timeType: DeGiroTimeTypes.DAY,\n price: 270, // limit price\n // stopPrice: 2,\n }\n\n const { confirmationId, freeSpaceNew, transactionFees } = await degiro.createOrder(order)\n const orderId = await degiro.executeOrder(order, confirmationId)\n console.log(`Order executed with id: ${orderId}`)\n } catch (error) {\n console.error(error)\n }\n})()import DeGiro, { DeGiroEnums, DeGiroTypes } from 'degiro-api'\nconst { DeGiroActions, DeGiroMarketOrderTypes, DeGiroTimeTypes } = DeGiroEnums\nconst { OrderType } = DeGiroTypes\n\n(async () => {\n\n const degiro: DeGiro = new DeGiro({\n username: 'nachoogoomezomg',\n pwd: <string>process.env.DEGIRO_PWD,\n })\n\n await degiro.login()\n\n const order: OrderType = {\n buySell: DeGiroActions.BUY,\n orderType: DeGiroMarketOrderTypes.LIMITED,\n productId: '331868', // $AAPL - Apple Inc\n size: 1,\n timeType: DeGiroTimeTypes.DAY,\n price: 272, // limit price\n // stopPrice: 2,\n }\n\n const { confirmationId, freeSpaceNew, transactionFees } = await degiro.createOrder(order)\n const orderId = await degiro.executeOrder(order, confirmationId)\n console.log(`Order executed with id: ${orderId}`)\n\n // Wait few seconds to avoid "Rate limit for the given request exceeded" error\n const TIMEOUT_SECONDS = 2 * 1000\n const deleteOrderFunction = async () => {\n try {\n await degiro.deleteOrder(orderId)\n console.log('Order removed')\n } catch (error) {\n console.error(error)\n }\n }\n setTimeout(deleteOrderFunction, TIMEOUT_SECONDS)\n})()degiro-cli is an usefull command line interface that help us dealing with DeGiro platform through the terminal. You can see your portfolio status, create and execute orders and much more (may in the future)
\n\t\t\t\t$ degiro\nUsage: DeGiro Command Line Interface [options] [command]\n\nDeGiro CLI provide you access to DeGiro Broker across the terminal\n\nOptions:\n -V, --version output the version number\n -h, --help display help for command\n\nCommands:\n login validate credentials with DeGiro platform\n search Search products in DeGiro\n portfolio show account portfolio in real-time\n help [command] display help for commandMIT
\n\t\t\t\t\n\t\t\t\t\tGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerate a download URL to the report with the id identifier
Generated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nGenerated using TypeDoc
\nApply filter to get only open or closed positions or get all available positions
\n\t\t\t\t\t\t\t\tTransform the object format of a portfolio position
\n\t\t\t\t\t\t\t\tGenerated using TypeDoc
\n
\n\t\t\t\t\t\t- description
\n\t\t\t\t\t\t
\n\t\t\t\tMain class of DeGiro Unofficial API.
\n\t\t\t\t\t\t