Credits API (Billing, Payments and Credits)

Credits API is a system for administration of credits and payments for them.

See also Credits ReDoc API reference.

Concept

Some actions available through SpaceKnow APIs may be performed only within allocated areas and scenes. Users are grouped into groups where each group has credits. These credits can be exchanged for an area allocation.

For example:

Olivia and William are part of group called Smiths. Olivia wants to perform an analysis on multiple satellite images from San Francisco acquired between 4th May 2016 and 20th June 2017. Before she can do any analysis, she has to allocate scenes and location via Credits API. She does that with an API call.

There are 7 scenes found for provider GBDX and dataset IDAHO-PANSHARPENED between May 2016 and June 2017 and San Francisco has 121 \(km^2\). Mentioned dataset uses 0.1 credits per \(km^2\). This means that \(7 \cdot 121 \cdot 0.1 = 84.7\) credits is subtracted from group Smiths in exchange for that area. From now on all users from group Smiths (Olivia and William) can perform unlimited analysis of satellite images of San Francisco from dates between May 2016 and June 2017.

Credits usage is also recorded for each user and there can be a limit set how many credits given user can allocate.

Selected imagery only

The Credits API currently applies to selected imagery only. To access other types of imagery, a special permission is required instead.

Free Scenes

The API offers several free scenes suitable for testing purposes. This gives customers a chance to evaluate the product without any commitment. Free scenes belong to four different datasets and have the following scene IDs:

  • SkySatCollect

    • Damascus airport, Syria: DXc_f1UsDLmqvwlUy7tMaR7Ef_o0xKugm01Z89ozdQaXR4VE_JDYlFphZA

    • Rason port, North Korea: DXc_f1UsDLmqvwlUy7tMaR7Ef_o0xKorOIEI5wOjJZ1uPs-pGBrpZZqxkPk

  • PSScene4Band

    • Muscat port, Oman: DXc_fDDq0LelifmD5a2tXfDvPyrnEPSY4gQndqXHnfeQ7Mz_oCBu

    • Zhoushan archipelago, China: DXc_fDDq0LelifmD5a2tXfDvPyrnEPSSYXbgq3nu7BryeTz8wwzF

  • COPERNICUS/S1_GRD

    • Crimea peninsula, Ukraine: GAl45wSsIlxfNFn4l-NQ4Z6zDlAvcMTIfZpmbO2CsLoY7RpcYV31BoHldkE6WW10QP_ubR8seEXNrRPymC4UDNdNqR66Iorc5_R8R5klikxHKljXng9xnHcx4Rsy_nNtW8qLoffIX7IIyA

    • Bab al-Mandab strait, Djibuti/Yemen: GAl45wSsIlxfNFn4l-NQ4Z6zDlAvcMTIfZpmbO2CsLoY7RpcYV31BoHldkE6WW10QP_ubR8seEXNrRPymX9ZmhIbDc5HCIKGGE_indwErbRXNAM2UF_8gnuGlJiwwXlgKjcjzFAtRZwaZg

  • COPERNICUS/S2_SR_HARMONIZED

    • Rostov on Don, Russia: GAl45wSsIlxfNFn4l-NQ4rNhDi5tekrXHbVmis7UaE2OMlmqEQ7txkPP30TUiTMyR5ATG49_xU3UWz9bK-ZQUjaw_NJIT901yDzcsvbzpm8UjQrjhj7siSL1cwnqBX2Z-w

    • Rostov on Don, Russia: GAl45wSsIlxfNFn4l-NQ4rNhDi5tekrXHbVmis7UaE2OMlmqEQ7txkPP30TUiTMyR5ATG49_xU3UWz9bK-ZQUjaw-a5ZzASmLvOoEPdjQFtMNm3qSHUktqtpodLRN6cCFA

Check Area

See Check Area OpenAPI.

List Group Allocations

See List Group Allocations OpenAPI.

List Group Transactions

See List Group Transactions OpenAPI.

List User Transactions

See List User Transactions OpenAPI.

Set User Credit Limit

See Set User Credit Limit OpenAPI.

Get Credits User

See Get User OpenAPI.