Skip navigation links

FX Integration API JavaDoc (3.10.0-2065-f18cba7)

See: Description

Packages 
Package Description
com.caplin.generated.motif.common  
com.caplin.generated.motif.common.userdetails  
com.caplin.generated.motif.fx.blotter  
com.caplin.generated.motif.fx.book  
com.caplin.generated.motif.fx.orders  
com.caplin.generated.motif.fx.orders.bulkorderaction  
com.caplin.generated.motif.fx.orders.bulkorderaction.events.client  
com.caplin.generated.motif.fx.orders.bulkorderaction.events.server  
com.caplin.generated.motif.fx.orders.bulkordersubmission  
com.caplin.generated.motif.fx.orders.bulkordersubmission.events.client  
com.caplin.generated.motif.fx.orders.bulkordersubmission.events.server  
com.caplin.generated.motif.fx.orders.editstrategy  
com.caplin.generated.motif.fx.orders.editstrategy.events.client  
com.caplin.generated.motif.fx.orders.editstrategy.events.server  
com.caplin.generated.motif.fx.orders.fieldsets  
com.caplin.generated.motif.fx.orders.ordercancel  
com.caplin.generated.motif.fx.orders.ordercancel.events.client  
com.caplin.generated.motif.fx.orders.ordercancel.events.server  
com.caplin.generated.motif.fx.orders.orderchangestate  
com.caplin.generated.motif.fx.orders.orderchangestate.events.client  
com.caplin.generated.motif.fx.orders.orderchangestate.events.server  
com.caplin.generated.motif.fx.orders.orderdeletion  
com.caplin.generated.motif.fx.orders.orderdeletion.events.client  
com.caplin.generated.motif.fx.orders.orderdeletion.events.server  
com.caplin.generated.motif.fx.orders.ordersubmission  
com.caplin.generated.motif.fx.orders.ordersubmission.events.client  
com.caplin.generated.motif.fx.orders.ordersubmission.events.server  
com.caplin.generated.motif.fx.rates  
com.caplin.generated.motif.fx.tradeconfirmation  
com.caplin.generated.motif.fx.tradedetails  
com.caplin.generated.motif.fx.trading.amend  
com.caplin.generated.motif.fx.trading.amend.events.client  
com.caplin.generated.motif.fx.trading.amend.events.server  
com.caplin.generated.motif.fx.trading.cancel  
com.caplin.generated.motif.fx.trading.cancel.events.client  
com.caplin.generated.motif.fx.trading.cancel.events.server  
com.caplin.generated.motif.fx.trading.esp  
com.caplin.generated.motif.fx.trading.esp.events.client  
com.caplin.generated.motif.fx.trading.esp.events.server  
com.caplin.generated.motif.fx.trading.fieldsets  
com.caplin.generated.motif.fx.trading.rfs  
com.caplin.generated.motif.fx.trading.rfs.events.client  
com.caplin.generated.motif.fx.trading.rfs.events.server  
com.caplin.generated.motif.fx.trading.rfscore  
com.caplin.generated.motif.fx.trading.rfscore.events.client  
com.caplin.generated.motif.fx.trading.rfscore.events.server  
com.caplin.generated.motif.fx.trading.salesintervention  
com.caplin.generated.motif.fx.trading.salesintervention.events.client  
com.caplin.generated.motif.fx.trading.salesintervention.events.server  
com.caplin.generated.motif.fx.trading.validate  
com.caplin.generated.motif.fx.trading.validate.events.client  
com.caplin.generated.motif.fx.trading.validate.events.server  
com.caplin.generated.motif.mm.blotter  
com.caplin.generated.motif.mm.rates  
com.caplin.generated.motif.mm.tradeconfirmation  
com.caplin.generated.motif.mm.tradedetails  
com.caplin.generated.motif.mm.trading.fieldsets  
com.caplin.generated.motif.mm.trading.mmrfs  
com.caplin.generated.motif.mm.trading.mmrfs.events.client  
com.caplin.generated.motif.mm.trading.mmrfs.events.server  
com.caplin.generated.motif.mm.trading.mmsalesintervention  
com.caplin.generated.motif.mm.trading.mmsalesintervention.events.client  
com.caplin.generated.motif.mm.trading.mmsalesintervention.events.server  
com.caplin.motif  
com.caplin.motif.common.userdetails  
com.caplin.motif.datasource
Extensions to the DataSource for Java library.
com.caplin.motif.fx.calendar
Classes and interfaces relating to tenor dates and settlement dates.
com.caplin.motif.fx.common  
com.caplin.motif.fx.orders
Parent package with classes and interfaces that relate to orders in general.
com.caplin.motif.fx.orders.upgrade  
com.caplin.motif.fx.rates
Classes and interfaces that relate to streaming FX rates.
com.caplin.motif.fx.trading
Parent package with classes that relate to FX trading in general but no specific trading protocol.
com.caplin.motif.fx.trading.allocation
Classes and interfaces that relate to post-trade allocations.
com.caplin.motif.fx.trading.allocation.event
Classes representing the events that can happen during the post-trade allocation process.
com.caplin.motif.fx.trading.allocation.responder
Classes used for sending post-trade allocation events.
com.caplin.motif.fx.trading.block
Classes and interfaces that relate to block trading.
com.caplin.motif.fx.trading.block.event
Classes representing the events that can happen during the block trade process.
com.caplin.motif.fx.trading.block.responder
Classes used for sending block trade events.
com.caplin.motif.fx.trading.orders
Parent package with classes and interfaces that relate to orders in general.
com.caplin.motif.fx.trading.orders.activestatechange
Classes and interfaces that relate to activating or deactivating a previously submitted order or strategy.
com.caplin.motif.fx.trading.orders.activestatechange.event
Events that can happen during activation or deactivation of a previously submitted order or strategy.
com.caplin.motif.fx.trading.orders.activestatechange.responder
Classes used for sending events that relate to activation or deactivation of an order or strategy.
com.caplin.motif.fx.trading.orders.bulkaction
Classes and interfaces that relate to performing bulk order action e.g.
com.caplin.motif.fx.trading.orders.bulkaction.event
Events that can happen during bulk order action.
com.caplin.motif.fx.trading.orders.bulkaction.responder
Classes used for sending events that relate to performing bulk order actions.
com.caplin.motif.fx.trading.orders.cancelation
Class and interfaces that relate to canceling a previously submitted order or strategy.
com.caplin.motif.fx.trading.orders.cancelation.event
Classes that represent the events that can happen during a request for cancelation of an order or strategy.
com.caplin.motif.fx.trading.orders.cancelation.responder
Classes used for sending events relating to the cancelation of an order or strategy.
com.caplin.motif.fx.trading.orders.details
Classes and interfaces that relate to supplying the details of a previously submitted order strategy.
com.caplin.motif.fx.trading.orders.edit
Classes and interfaces that relate to editing an existing order or order strategy.
com.caplin.motif.fx.trading.orders.edit.event
Classes that represent the events that can happen during an attempt to edit an existing order or order strategy.
com.caplin.motif.fx.trading.orders.edit.responder
Classes used for sending events that relate to editing an existing order or order strategy.
com.caplin.motif.fx.trading.orders.submission
Classes and interfaces that relate to submitting an order or order strategy.
com.caplin.motif.fx.trading.orders.submission.event
Classes that represent the events that can happen during submission of an order strategy.
com.caplin.motif.fx.trading.orders.submission.responder
Classes used for sending events that relate to an order strategy submission.
com.caplin.motif.fx.trading.orders.submission.strategy
Classes representing the various order strategies that are supported by the FX Motif.
com.caplin.motif.fx.trading.orders.submission.validator
Classes that validate the correctness of a submitted order strategy.
com.caplin.motif.fx.trading.validator
Classes and interfaces that relate to validating trade events.
com.caplin.motif.mm.rates
Classes and interfaces that relate to streaming MM rates.
com.caplin.motif.mm.trading  
com.caplin.motif.utility  

Overview

The FX Integration API is a backend Java library that you can use to quickly and easily integrate the Caplin FX Motif with your existing systems. The library consists of a set of domain-specific APIs designed to provide the data expected by the FX Motif, in the exact format required.

The FX Integration API fully supports the core features of the FX Motif, including (but not limited to):

When using the FX Motif backend system - Caplin Platform - to integrate with your existing backend systems and stream real-time data to your client applications via the internet, the server-side APIs that you interact with are generally based on receiving requests and sending messages made up of fields. These fields are simple key/value pairs. The FX Integration API enforces a standard protocol with the FX Motif that enables developers to implement DataSource Integration Adapters conforming to the pricing and trading workflow that the FX Motif expects, without being overly concerned with field and message specifications. Thus the FX Integration API enables you to fully utilise all of the FX Motifs features while greatly reducing the amount of time developing Integration Adapters by writing a small amount of high level domain-specific integration code rather than writing a lot of low-level boilerplate code to build up raw messages and manually set fields.

For detailed information on using the FX Integration API - see our online documentation at www.caplin.com/developer. Here you will find further help and guides on developing DataSource Integration Adapters for the Caplin FX Motif using the FX Integration API.

Skip navigation links

Copyright © 2015 Caplin Systems.