Skip Navigation LinksHome > Products > Web Service Catalog > XigniteMetals

Web Service Operations GetIntradayMetalFutureChartCustom

Sign up for a free-trial now to test this operation!
No test form is available as this service or method does not support the HTTP GET protocol.

Web Service Description

Get a custom intraday price chart for a future contract.


Web Service Hits Calculation

Requests against this operation count as one hit.

Inputs and Outputs Parameters for GetIntradayMetalFutureChartCustom

Inputs

NameDescriptionRequiredExample
TypeThe type of metal future.YesCOMEXGold
MonthThe delivery month for the future contract. Use the current month for spot prices.Yes12
YearThe contract year for the future contract. Use the current year for spot prices.Yes2009
StartTimeThe start time (EST) for the chart (use the HH:MM:SS.mmmm) format. For instance, you would enter 3:00 PM EST as 15:00:00.0000. you can omit seconds and milliseconds. The earliest available time is 7:00:00.Yes8:00
EndTimeThe start time (EST) for the chart (use the HH:MM:SS.mmmm) format. For instance, you would enter 12:00 PM EST as 12:00:00.0000. you can omit seconds and milliseconds. The latest available time is 20:00:00.Yes20:00
StyleThe style of the chart.YesLine
WidthThe width of the chart.Yes600
HeightThe height of the chart.Yes400
Instance of ChartDesignReturns one instance of the chart design class.Yes 
SecureWhether the URL of the chart should be HTTPS or HTTPYes 
TextTitle The title of the chart. Leave blank to use the Ticker symbol as a title. You can use the following placeholders in the title when applicable:
  • $symbol$ for the security symbol.
  • $name$ for the security name.
  • $startdate$ for the chart start date.
  • $enddate$ for the chart end date.
  • $today$ for today's date.
  • $cr$ for a carriage return.
Yes$name$ ($symbol$)$cr$
$startdate$ - $enddate$
TextHeaderThe text of the header displayed under the title. You can use the same placeholders as TextTitle.YesChart
TextFooterThe text of the footer displayed on the bottom right corner.YesCopyright (c) 2003 Xignite,
Inc.
TextPriceLine The text for the price data series. You can use the following placeholders:
  • $symbol$ for the security symbol.
YesPrice
TextVolumeBar The text for the volume data series. You can use the following placeholders:
  • $symbol$ for the security symbol.
YesVolume
TextHighestThe text for the high price line, if ShowHigh is set to true.YesHigh
TextLowestThe text for the low price line, if ShowLow is set to true.YesLow
TextOpenThe text for the open price line, if ShowOpen is set to true.YesOpen
TextCloseThe text for the closed price line, if ShowClose is set to true.YesClose
TextUp The text for the up variations if ShowVariations is set to true.
  • $year$ the number of years for the variation.
Yes2009-Year Increase
TextDown The text for the down variations if ShowVariations is set to true.
  • $year$ the number of years for the variation.
Yes2009-Year Decline
ColorBackgroundThe background color. This color is used to build background gradients for the wall and background.Yes#EDE8CC
ColorBackWallThe backwall color. This color is used to build background gradients for the wall and background.Yes#EDE8CC
ColorVolumeBackWallThe background color. This color is used to build background gradients for the wall and background.Yes#FFFFFF
ShowVolumeBackWallEnable or disable the backwall of the volume chart.YesFalse
ColorHighlightThe hightlight color used for the footer.Yes#353BA7
ColorPriceLineThe color of the price line.Yes#353BA6
ColorVolumeBarThe color of the volume bar.Yes#6E6E47
ColorVolumeBarFillThe fill color of the volume bar.Yes#6E6E47
ColorHighThe color of the high price line and label. Use the #RRGGBB format where RR, GG, and BB are the red, blue, and green values in HEX format.Yes#B22222
ColorStickUpThe color of the up sticks in Candlestick charts. Use the #RRGGBB format where RR, GG, and BB are the red, blue, and green values in HEX format.Yes#009900
ColorStickLowThe color of the down sticks in Candlestick charts. Use the #RRGGBB format where RR, GG, and BB are the red, blue, and green values in HEX format.Yes#FF0000
ColorConstantThe color of constant lines. Use the #RRGGBB format where RR, GG, and BB are the red, blue, and green values in HEX format.Yes#333399
ColorLowThe color of the low price line and label. Use the #RRGGBB format where RR, GG, and BB are the red, blue, and green values in HEX format.Yes#DBC309
ColorPointThe color for displayed points, such as .Yes#000000
ColorTitleThe title color.Yes#000000
ColorFooterThe footer color.Yes#000000
ColorHeaderThe header color.Yes#000000
ColorAxisThe axis color.Yes#000000
ColorGridThe outer grid color.Yes#000000
ColorFontsThe right axis, bottom axis, and legend font colors.Yes#000000
ColorStripeThe color of the back wall strip indicating the market opening period, when applicable.Yes#EDE8CC
ColorOpenThe color of the open price line and label. Use the #RRGGBB format where RR, GG, and BB are the red, blue, and green values in HEX format.Yes#DBC309
ColorCloseThe color of the close price line and label. Use the #RRGGBB format where RR, GG, and BB are the red, blue, and green values in HEX format.Yes#DBC309
ColorVerticalGridThe vertical grid color.Yes#000000
ColorHorizontalGridThe horizontal grid color.Yes#000000
ColorUpThe color up color for candlesticks charts.Yes#000000
ColorDownThe color down color for candlesticks charts.Yes#000000
ColorHighLowLineThe high-low line color for candlesticks charts.Yes#000000
ColorCollectionThe list of colors to apply when more than one symbol is displayed.Yes#CE0000,#CE9C00,#3300FF,#00CC
00,#9900CC,#FF6600,#0099F
F
GridHorizontalStyleThe pattern for the horizontal grid.YesSolid
GridVerticalStyleThe pattern for the vertical grid.YesDot
GridHorizontalWidthThe width for the horizontal grid lines.Yes1
GridVerticalWidthThe width for the vertical grid lines.Yes1
ColorFrameThe outer frame color.Yes#000000
FormatPriceLineThe format for prices. Example: #,##0.000 for 3 decimals.Yes#,##0.00
FormatVolumeThe format for volumes. Example: use #,###0.0 to show one decimal.Yes#,##0 M
FormatDateThe format for dates.YesM/yyyy
GradeBackgroundIf set to true, the color of chart background is set as a diagonal right-to-left gradient from ColorDarkTone to ColorLightTone. Use the #RRGGBB format where RR, GG, and BB are the red, blue, and green values in HEX format.Yestrue
GradeBackwallIf set to true, the color of wall background is set as a diagonal left-to-right gradient from ColorDarkTone to ColorLightTone. Use the #RRGGBB format where RR, GG, and BB are the red, blue, and green values in HEX format.Yestrue
WaterMarkThe address of the watermark file. Please contact us to set this parameter.Yes 
WaterMarkTopMarginThe top position of the watermark, in percentage (0=Top, 100=Bottom)Yes100
WaterMarkLeftMarginThe left position of the watermark, in percentage (0=Left, 100=Right).Yes100
WaterMarkTransparencyThe watermark transparency (in percentage).Yes50
PointSizeThe point size for point charts (i.e. SEC filings on market capitalization charts).Yes0.015
LineWidthThe width of the line series (in pixels).Yes1
SplitPercentThe percentage of the chart aera allocated to displaying trade volumes.Yes20
ShowHighShow the high price line.Yestrue
ShowLowShow the low price line.Yestrue
ShowOpenShow the open price line.Yestrue
ShowCloseShow the close price line.Yestrue
ShowVolumeShow the volume data at the bottom of the chart.Yestrue
ShowUpVariationShow the down variations (largest declines) for the stock.Yesfalse
ShowDownVariationShow the up variations for the stock. Not Supported.Yesfalse
ShowLegendShow the legend of the chart.Yestrue
VariationYearThe variation year for the chart.Yes2006
VolumeDividerA divider to apply to volume numbers.Yes1000
VolumeTextOffThe text off for the volume numbers.Yes1000
PriceTextOffThe text off for the price numbers.Yes1000
FrameTypeThe type of frame to display around the chart.YesNone
LightSchemeThe lighting scheme to apply to the chart 3D projection.YesNorthernLights
ProjectionThe 3D projection for the chart.YesNorthernLights
MarginTopThe top margin expressed as a percentage of the chart area.Yes0
MarginBottomThe bottom margin expressed as a percentage of the chart area.Yes0
MarginLeftThe left margin expressed as a percentage of the chart area.Yes0
MarginRightThe right margin expressed as a percentage of the chart area.Yes0
FontFamilyThe font family to apply to all texts.YesArial
FontSizeLegendThe size of the legend fonts.Yes10
FontSizeAxesThe size of the axes fonts.Yes10
FontSizeTitleThe size of the title fonts.Yes14
FontSizeHeaderThe size of the header fonts.Yes10
FontSizeFooterThe size of the footer fonts.Yes10
HeightThe height of the chart within the frame.Yes1
WidthThe width of the chart within the frame.Yes1
ZoomPercentThe percent to zoom for the chart.Yes10
ReloadIf the chart will reload.Yestrue
ShowPriceChartLabelsShow the price chart labels for the legend.Yestrue
LegendBoxShow the background for the legend.Yesfalse
ColorLegendBackgroundThe color of the background of the legend.Yes#000000
ColorLegendBorderThe color of the border of the legend.Yes#000000
LegendVerticalPositionThe top position of the legend (0=Top, 100=Bottom).Yes2
LegendHorizontalPositionThe left position of the legend (0=Left, 100=Right).Yes93
TickPrecision

The precision unit to apply to the ticks of the chart. Choose:

  • Tick to draw one point per trade (could be thousands for highly traded securities). TickPeriods does not apply in this case.
  • Milliseconds to summarize trades by the number of milliseconds specified by TickPeriods.
  • Second to summarize trades by the number of seconds specified by TickPeriods.
  • Minute to summarize trades by the number of minutes specified by TickPeriods.

For instance TickPeriod=2 and TickPrecision=Minute will plot one value of the chart for trades executed every two minutes.

YesMinute
TickPeriodsUsed in combination with TickPrecision to define the number of points displayed on the chart. For instance TickPeriods=5 with TickPrecision=Minute will display one data point every 5 minutes with the point being the average price for that period.Yes1

Outputs

NameDescriptionAlways Present
Instance of FutureEach instance represents a future. 
 Instance of FutureEach instance represents a future. 
  SymbolThe symbol for the future contract.Yes
  NameThe name of the underlying commodity.Yes
  MonthThe delivery month for the future contract (spot month by default).Yes
  YearThe delivery year for the future (contract spot year by default).Yes
  ExchangeThe exchange where the future contract is traded.Yes
  ExchangeSymbolThe symbol of the exchange where the future contract is traded.Yes
 StartTimeThe start time (EST) for the chart.Yes
 EndTimeThe start time (EST) for the chart.Yes
 WidthThe width of the chart.Yes
 HeightThe height of the chart.Yes
 TitleThe title of the chart.Yes
 StyleThe style of the chart.Yes
 UrlThe url for the chart.Yes

SOAP Request for GetIntradayMetalFutureChartCustom

Inputs

POST http://www.xignite.com/xMetals.asmx HTTP/1.1
Host: www.xignite.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.xignite.com/services/GetIntradayMetalFutureChartCustom"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Header> <Header xmlns="http://www.xignite.com/services/"> <Username>string</Username> <Password>string</Password> <Tracer>string</Tracer> </Header> </soap:Header> <soap:Body> <GetIntradayMetalFutureChartCustom xmlns="http://www.xignite.com/services/"> <Type>COMEXGold or COMEXSilver or NYMEXPlatinum or NYMEXPalladium
or CBOTGold or CBOTSilver or CBOTGoldMiniSized or CBOTSilverMiniSized
</Type> <StartTime>string</StartTime> <EndTime>string</EndTime> <Style>Line or Candle or Stick or Area or Percentage or LinePercentage
or CandlePercentage or StickPercentage or AreaPercentage
</Style> <Width>int</Width> <Height>int</Height> <Design> <Secure>boolean</Secure> <TextTitle>string</TextTitle> <TextHeader>string</TextHeader> <TextFooter>string</TextFooter> <TextPriceLine>string</TextPriceLine> <TextVolumeBar>string</TextVolumeBar> <TextHighest>string</TextHighest> <TextLowest>string</TextLowest> <TextOpen>string</TextOpen> <TextClose>string</TextClose> <TextUp>string</TextUp> <TextDown>string</TextDown> <ColorBackground>string</ColorBackground> <ColorBackWall>string</ColorBackWall> <ColorVolumeBackWall>string</ColorVolumeBackWall> <ShowVolumeBackWall>boolean</ShowVolumeBackWall> <ColorHighlight>string</ColorHighlight> <ColorPriceLine>string</ColorPriceLine> <ColorVolumeBar>string</ColorVolumeBar> <ColorVolumeBarFill>string</ColorVolumeBarFill> <ColorHigh>string</ColorHigh> <ColorStickUp>string</ColorStickUp> <ColorStickLow>string</ColorStickLow> <ColorConstant>string</ColorConstant> <ColorLow>string</ColorLow> <ColorPoint>string</ColorPoint> <ColorTitle>string</ColorTitle> <ColorFooter>string</ColorFooter> <ColorHeader>string</ColorHeader> <ColorAxis>string</ColorAxis> <ColorGrid>string</ColorGrid> <ColorFonts>string</ColorFonts> <ColorStripe>string</ColorStripe> <ColorOpen>string</ColorOpen> <ColorClose>string</ColorClose> <ColorVerticalGrid>string</ColorVerticalGrid> <ColorHorizontalGrid>string</ColorHorizontalGrid> <ColorUp>string</ColorUp> <ColorDown>string</ColorDown> <ColorHighLowLine>string</ColorHighLowLine> <ColorCollection>string</ColorCollection> <GridHorizontalStyle>Solid or Dot or Dash or DashDot or DashDotDot</GridHorizontalStyle> <GridVerticalStyle>Solid or Dot or Dash or DashDot or DashDotDot</GridVerticalStyle> <GridHorizontalWidth>int</GridHorizontalWidth> <GridVerticalWidth>int</GridVerticalWidth> <ColorFrame>string</ColorFrame> <FrameBorder>string</FrameBorder> <FormatPriceLine>string</FormatPriceLine> <FormatVolume>string</FormatVolume> <FormatDate>string</FormatDate> <GradeBackground>boolean</GradeBackground> <GradeBackwall>boolean</GradeBackwall> <WaterMark>string</WaterMark> <WaterMarkTopMargin>int</WaterMarkTopMargin> <WaterMarkLeftMargin>int</WaterMarkLeftMargin> <WaterMarkTransparency>int</WaterMarkTransparency> <PointSize>float</PointSize> <StackVariationLabels>boolean</StackVariationLabels> <ShowAxisLabelInLegend>boolean</ShowAxisLabelInLegend> <LineWidth>int</LineWidth> <SplitPercent>int</SplitPercent> <ShowHigh>boolean</ShowHigh> <ShowLow>boolean</ShowLow> <ShowOpen>boolean</ShowOpen> <ShowClose>boolean</ShowClose> <ShowVolume>boolean</ShowVolume> <ShowUpVariation>boolean</ShowUpVariation> <ShowDownVariation>boolean</ShowDownVariation> <ShowLegend>boolean</ShowLegend> <VariationYear>int</VariationYear> <VolumeDivider>int</VolumeDivider> <VolumeTextOffset>int</VolumeTextOffset> <PriceTextOffset>int</PriceTextOffset> <FrameType>None or Colonial or Common or Embed or Emboss or FrameOpenRight
or FrameOpenRL or OneBarGradient or RoundedUp or SlimRoundedShadowed
</FrameType> <Projection>Orthogonal or OrthogonalElevated or OrthogonalHorizontalLeft
or OrthogonalHorizontalRight or OrthogonalHalf or OrthogonalHalfHorizontalLeft
or OrthogonalHalfHorizontalRight or OrthogonalHalfRotated
or OrthogonalHalfElevated or Perspective or PerspectiveHorizontalLeft
or PerspectiveHorizontalRight or PerspectiveRotated
or PerspectiveElevated or PerspectiveTilted</Projection> <MarginTop>int</MarginTop> <MarginBottom>int</MarginBottom> <MarginLeft>int</MarginLeft> <MarginRight>int</MarginRight> <FontFamily>string</FontFamily> <FontSizeHeader>int</FontSizeHeader> <FontSizeFooter>int</FontSizeFooter> <Height>double</Height> <Width>double</Width> <ZoomPercent>int</ZoomPercent> <LegendBox>boolean</LegendBox> <ColorLegendBackground>string</ColorLegendBackground> <ColorLegendBorder>string</ColorLegendBorder> <LegendVerticalPosition>int</LegendVerticalPosition> <LegendHorizontalPosition>int</LegendHorizontalPosition> <Reload>boolean</Reload> <ShowPriceChartLabels>boolean</ShowPriceChartLabels> <TickPrecision>Tick or Millisecond or Second or Minute or Hour or Day
or Week or Month</TickPrecision> <TickPeriods>int</TickPeriods> <WaterMarkHorizontalAlign>Center or Left or Right</WaterMarkHorizontalAlign> <LightScheme>None or SoftTopLeft or SoftFrontal or SoftTopRight or ShinyTopLeft
or ShinyFrontal or ShinyTopRight or MetallicLustre
or NorthernLights</LightScheme> <FontSizeLegend>int</FontSizeLegend> <FontSizeAxes>int</FontSizeAxes> <FontSizeTitle>int</FontSizeTitle> <DaysForHourDisplay>int</DaysForHourDisplay> <DaysForDayDisplay>int</DaysForDayDisplay> <DaysForWeekDisplay>int</DaysForWeekDisplay> <DaysForBiWeeklyDisplay>int</DaysForBiWeeklyDisplay> <DaysForMonthDisplay>int</DaysForMonthDisplay> <DaysForQuarterDisplay>int</DaysForQuarterDisplay> <DaysForSemiAnnualDisplay>int</DaysForSemiAnnualDisplay> <DaysForAnnualDisplay>int</DaysForAnnualDisplay> <DaysForBiAnnualDisplay>int</DaysForBiAnnualDisplay> <DaysForPentaAnnualDisplay>int</DaysForPentaAnnualDisplay> </Design> </GetIntradayMetalFutureChartCustom> </soap:Body> </soap:Envelope>

Outputs

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <GetIntradayMetalFutureChartCustomResponse xmlns="http://www.xignite.com/services/"> <GetIntradayMetalFutureChartCustomResult> <Future> <Symbol>string</Symbol> <Name>string</Name> <Month>int</Month> <Year>int</Year> <Exchange>string</Exchange> <ExchangeSymbol>string</ExchangeSymbol> <Type>Future or Swap</Type> </Future> <StartTime>string</StartTime> <EndTime>string</EndTime> <Width>int</Width> <Height>int</Height> <Title>string</Title> <Style>Line or Candle or Stick or Area or Percentage or LinePercentage
or CandlePercentage or StickPercentage or AreaPercentage
</Style> <Url>string</Url> </GetIntradayMetalFutureChartCustomResult> </GetIntradayMetalFutureChartCustomResponse> </soap:Body> </soap:Envelope>

HttpGet Request for GetIntradayMetalFutureChartCustom

Inputs

HTTP GET is not supported for this operation because it requires at least on complex object 
as input parameter. Only SOAP is supported.

Outputs

HTTP GET is not supported for this operation because it requires at least on complex object 
as input parameter. Only SOAP is supported.

HttpPost Request for GetIntradayMetalFutureChartCustom

Inputs

HTTP POST is not supported for this operation because it requires at least on complex object 
as input parameter. Only SOAP is supported.

Outputs

HTTP POST is not supported for this operation because it requires at least on complex object 
as input parameter. Only SOAP is supported.

The sample code form is only available for methods with primitive types as parameters.

 
Copyright © 2009 Xignite, Inc. All Rights Reserved.




Hostname: xignite15