@monerium/sdk
A library to interact with Monerium API.
Installation
pnpm add @monerium/sdk
Example
import { MoneriumClient } from '@monerium/sdk';
const monerium = new MoneriumClient({
clientId: '...',
redirectUri: '...',
environment: 'sandbox',
})
// Will redirect the user to Monerium's authentication code flow.
await monerium.authorize();
// Will use the authorization code flow code to get access token
await monerium.getAccess();
// or use refresh token to get access token if provided.
await monerium.getAccess(refreshToken);
// Retrieve profiles the client has access to.
await monerium.getProfiles();
References
default
Renames and re-exports MoneriumClient
Classes
Functions
Variables
Interfaces
- Address
- AddressesQueryParams
- AddressesResponse
- AuthCodePayload
- AuthFlowOptions
- AuthFlowOptionsShared
- AuthFlowSIWEOptions
- AuthorizationCodeCredentials
- Balances
- BearerProfile
- ClientCredentials
- ClientCredentialsPayload
- CorporateProfileDetails
- CorporateProfileDetailsRequest
- Corporation
- Counterpart
- CrossChainIdentifier
- CurrencyBalance
- Fee
- IBAN
- IBANIdentifier
- IbansQueryParams
- IBANsResponse
- Identifier
- Individual
- KYC
- LinkAddress
- LinkedAddress
- MoveIbanPayload
- NewOrderByAccountId
- NewOrderByAddress
- NewOrderCommon
- Order
- OrderFilter
- OrderMetadata
- OrderNotificationQueryParams
- OrdersResponse
- PersonalProfileDetails
- PersonalProfileDetailsRequest
- PKCERequest
- PKCERequestShared
- PKCESIWERequest
- Profile
- ProfilesQueryParams
- ProfilesResponse
- RefreshTokenPayload
- RequestIbanPayload
- SCANIdentifier
- SupportingDoc
- SupportingDocMetadata
- Token
Type Aliases
- AuthArgs
- BearerTokenCredentials
- Beneficiary
- Chain
- ChainId
- ClassOptions
- Config
- CosmosChainId
- CurrencyCode
- Director
- ENV
- Environment
- EvmChainId
- NewOrder
- PKCERequestArgs
- PKCERSIWERequestArgs
- ProductionChain
- ProfilePermissions
- Representative
- ResponseStatus
- SandboxChain
- SubmitProfileDetailsPayload
- Ticker
- TokenSymbol